Genomics API . workers

Instance Methods

checkIn(id, body=None, x__xgafv=None)

The worker uses this method to retrieve the assigned operation and provide periodic status updates.

close()

Close httplib2 connections.

Method Details

checkIn(id, body=None, x__xgafv=None)
The worker uses this method to retrieve the assigned operation and provide periodic status updates.

Args:
  id: string, The VM identity token for authenticating the VM instance. https://cloud.google.com/compute/docs/instances/verifying-instance-identity (required)
  body: object, The request body.
    The object takes the form of:

{ # The parameters to the CheckIn method.
    "events": [ # A list of timestamped events.
      { # An event that occured in the operation assigned to the worker and the time of occurance.
        "timestamp": "A String", # The time when the event happened.
        "data": { # The event data.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      },
    ],
    "result": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The operation has finished with the given result.
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    "sosReport": "A String", # An SOS report for an unexpected VM failure.
    "deadlineExpired": { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. # The deadline has expired and the worker needs more time.
    },
    "workerStatus": { # The status of the worker VM. # Data about the status of the worker VM.
      "attachedDisks": { # Status of attached disks.
        "a_key": { # The status of a disk on a VM.
          "freeSpaceBytes": "A String", # Free disk space.
          "totalSpaceBytes": "A String", # Total disk space.
        },
      },
      "totalRamBytes": "A String", # Total RAM.
      "uptimeSeconds": "A String", # System uptime.
      "bootDisk": { # The status of a disk on a VM. # Status of the boot disk.
        "freeSpaceBytes": "A String", # Free disk space.
        "totalSpaceBytes": "A String", # Total disk space.
      },
      "freeRamBytes": "A String", # Free RAM.
    },
    "event": { # A workflow specific event occurred.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response to the CheckIn method.
    "metadata": { # The metadata that describes the operation assigned to the worker.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "deadline": "A String", # The deadline by which the worker must request an extension. The backend will allow for network transmission time and other delays, but the worker must attempt to transmit the extension request no later than the deadline.
  }
close()
Close httplib2 connections.