Rapid Migration Assessment API . projects . locations . annotations

Instance Methods

close()

Close httplib2 connections.

create(parent, body=None, requestId=None, x__xgafv=None)

Creates an Annotation

get(name, x__xgafv=None)

Gets details of a single Annotation.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, requestId=None, x__xgafv=None)
Creates an Annotation

Args:
  parent: string, Required. Name of the parent (project+location). (required)
  body: object, The request body.
    The object takes the form of:

{ # Message describing an Annotation
  "createTime": "A String", # Output only. Create time stamp.
  "labels": { # Labels as key value pairs.
    "a_key": "A String",
  },
  "name": "A String", # name of resource.
  "type": "A String", # Type of an annotation.
  "updateTime": "A String", # Output only. Update time stamp.
}

  requestId: string, Optional. An optional request ID to identify requests.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # 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 error result of the operation in case of failure or cancellation.
    "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.
      },
    ],
    "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.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}
get(name, x__xgafv=None)
Gets details of a single Annotation.

Args:
  name: string, Required. Name of the resource. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message describing an Annotation
  "createTime": "A String", # Output only. Create time stamp.
  "labels": { # Labels as key value pairs.
    "a_key": "A String",
  },
  "name": "A String", # name of resource.
  "type": "A String", # Type of an annotation.
  "updateTime": "A String", # Output only. Update time stamp.
}