Rapid Migration Assessment API . projects . locations . collectors

Instance Methods

close()

Close httplib2 connections.

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

Create a Collector to manage the on-prem appliance which collects information about Customer assets.

delete(name, requestId=None, x__xgafv=None)

Deletes a single Collector - changes state of collector to "Deleting". Background jobs does final deletion thorugh producer api.

get(name, x__xgafv=None)

Gets details of a single Collector.

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists Collectors in a given project and location.

list_next()

Retrieves the next page of results.

patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)

Updates the parameters of a single Collector.

pause(name, body=None, x__xgafv=None)

Pauses the given collector.

register(name, body=None, x__xgafv=None)

Registers the given collector.

resume(name, body=None, x__xgafv=None)

Resumes the given collector.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, collectorId=None, requestId=None, x__xgafv=None)
Create a Collector to manage the on-prem appliance which collects information about Customer assets.

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

{ # Message describing Collector object.
  "bucket": "A String", # Output only. Store cloud storage bucket name (which is a guid) created with this Collector.
  "clientVersion": "A String", # Output only. Client version.
  "collectionDays": 42, # How many days to collect data.
  "createTime": "A String", # Output only. Create time stamp.
  "description": "A String", # User specified description of the Collector.
  "displayName": "A String", # User specified name of the Collector.
  "eulaUri": "A String", # Uri for EULA (End User License Agreement) from customer.
  "expectedAssetCount": "A String", # User specified expected asset count.
  "guestOsScan": { # Message describing a MC Source of type Guest OS Scan. # Output only. Reference to MC Source Guest Os Scan.
    "coreSource": "A String", # reference to the corresponding Guest OS Scan in MC Source.
  },
  "labels": { # Labels as key value pairs.
    "a_key": "A String",
  },
  "name": "A String", # name of resource.
  "serviceAccount": "A String", # Service Account email used to ingest data to this Collector.
  "state": "A String", # Output only. State of the Collector.
  "updateTime": "A String", # Output only. Update time stamp.
  "vsphereScan": { # Message describing a MC Source of type VSphere Scan. # Output only. Reference to MC Source vsphere_scan.
    "coreSource": "A String", # reference to the corresponding VSphere Scan in MC Source.
  },
}

  collectorId: string, Required. Id of the requesting object.
  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.
  },
}
delete(name, requestId=None, x__xgafv=None)
Deletes a single Collector - changes state of collector to "Deleting". Background jobs does final deletion thorugh producer api.

Args:
  name: string, Required. Name of the resource. (required)
  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  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 Collector.

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 Collector object.
  "bucket": "A String", # Output only. Store cloud storage bucket name (which is a guid) created with this Collector.
  "clientVersion": "A String", # Output only. Client version.
  "collectionDays": 42, # How many days to collect data.
  "createTime": "A String", # Output only. Create time stamp.
  "description": "A String", # User specified description of the Collector.
  "displayName": "A String", # User specified name of the Collector.
  "eulaUri": "A String", # Uri for EULA (End User License Agreement) from customer.
  "expectedAssetCount": "A String", # User specified expected asset count.
  "guestOsScan": { # Message describing a MC Source of type Guest OS Scan. # Output only. Reference to MC Source Guest Os Scan.
    "coreSource": "A String", # reference to the corresponding Guest OS Scan in MC Source.
  },
  "labels": { # Labels as key value pairs.
    "a_key": "A String",
  },
  "name": "A String", # name of resource.
  "serviceAccount": "A String", # Service Account email used to ingest data to this Collector.
  "state": "A String", # Output only. State of the Collector.
  "updateTime": "A String", # Output only. Update time stamp.
  "vsphereScan": { # Message describing a MC Source of type VSphere Scan. # Output only. Reference to MC Source vsphere_scan.
    "coreSource": "A String", # reference to the corresponding VSphere Scan in MC Source.
  },
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Collectors in a given project and location.

Args:
  parent: string, Required. Parent value for ListCollectorsRequest. (required)
  filter: string, Filtering results.
  orderBy: string, Hint for how to order the results.
  pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  pageToken: string, A token identifying a page of results the server should return.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message for response to listing Collectors.
  "collectors": [ # The list of Collectors.
    { # Message describing Collector object.
      "bucket": "A String", # Output only. Store cloud storage bucket name (which is a guid) created with this Collector.
      "clientVersion": "A String", # Output only. Client version.
      "collectionDays": 42, # How many days to collect data.
      "createTime": "A String", # Output only. Create time stamp.
      "description": "A String", # User specified description of the Collector.
      "displayName": "A String", # User specified name of the Collector.
      "eulaUri": "A String", # Uri for EULA (End User License Agreement) from customer.
      "expectedAssetCount": "A String", # User specified expected asset count.
      "guestOsScan": { # Message describing a MC Source of type Guest OS Scan. # Output only. Reference to MC Source Guest Os Scan.
        "coreSource": "A String", # reference to the corresponding Guest OS Scan in MC Source.
      },
      "labels": { # Labels as key value pairs.
        "a_key": "A String",
      },
      "name": "A String", # name of resource.
      "serviceAccount": "A String", # Service Account email used to ingest data to this Collector.
      "state": "A String", # Output only. State of the Collector.
      "updateTime": "A String", # Output only. Update time stamp.
      "vsphereScan": { # Message describing a MC Source of type VSphere Scan. # Output only. Reference to MC Source vsphere_scan.
        "coreSource": "A String", # reference to the corresponding VSphere Scan in MC Source.
      },
    },
  ],
  "nextPageToken": "A String", # A token identifying a page of results the server should return.
  "unreachable": [ # Locations that could not be reached.
    "A String",
  ],
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        
patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)
Updates the parameters of a single Collector.

Args:
  name: string, name of resource. (required)
  body: object, The request body.
    The object takes the form of:

{ # Message describing Collector object.
  "bucket": "A String", # Output only. Store cloud storage bucket name (which is a guid) created with this Collector.
  "clientVersion": "A String", # Output only. Client version.
  "collectionDays": 42, # How many days to collect data.
  "createTime": "A String", # Output only. Create time stamp.
  "description": "A String", # User specified description of the Collector.
  "displayName": "A String", # User specified name of the Collector.
  "eulaUri": "A String", # Uri for EULA (End User License Agreement) from customer.
  "expectedAssetCount": "A String", # User specified expected asset count.
  "guestOsScan": { # Message describing a MC Source of type Guest OS Scan. # Output only. Reference to MC Source Guest Os Scan.
    "coreSource": "A String", # reference to the corresponding Guest OS Scan in MC Source.
  },
  "labels": { # Labels as key value pairs.
    "a_key": "A String",
  },
  "name": "A String", # name of resource.
  "serviceAccount": "A String", # Service Account email used to ingest data to this Collector.
  "state": "A String", # Output only. State of the Collector.
  "updateTime": "A String", # Output only. Update time stamp.
  "vsphereScan": { # Message describing a MC Source of type VSphere Scan. # Output only. Reference to MC Source vsphere_scan.
    "coreSource": "A String", # reference to the corresponding VSphere Scan in MC Source.
  },
}

  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Collector resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
  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.
  },
}
pause(name, body=None, x__xgafv=None)
Pauses the given collector.

Args:
  name: string, Required. Name of the resource. (required)
  body: object, The request body.
    The object takes the form of:

{ # Message for pausing a Collector.
  "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
}

  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.
  },
}
register(name, body=None, x__xgafv=None)
Registers the given collector.

Args:
  name: string, Required. Name of the resource. (required)
  body: object, The request body.
    The object takes the form of:

{ # Message for registering a Collector.
  "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
}

  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.
  },
}
resume(name, body=None, x__xgafv=None)
Resumes the given collector.

Args:
  name: string, Required. Name of the resource. (required)
  body: object, The request body.
    The object takes the form of:

{ # Message for resuming a Collector.
  "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
}

  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.
  },
}