Returns the importDataFiles Resource.
Close httplib2 connections.
create(parent, body=None, importJobId=None, requestId=None, x__xgafv=None)
Creates an import job.
delete(name, force=None, requestId=None, x__xgafv=None)
Deletes an import job.
get(name, view=None, x__xgafv=None)
Gets the details of an import job.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists all import jobs.
Retrieves the next page of results.
patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)
Updates an import job.
run(name, body=None, x__xgafv=None)
Runs an import job.
validate(name, body=None, x__xgafv=None)
Validates an import job.
close()
Close httplib2 connections.
create(parent, body=None, importJobId=None, requestId=None, x__xgafv=None)
Creates an import job.
Args:
parent: string, Required. Value for parent. (required)
body: object, The request body.
The object takes the form of:
{ # A resource that represents the background job that imports asset frames.
"assetSource": "A String", # Required. Reference to a source.
"completeTime": "A String", # Output only. The timestamp when the import job was completed.
"createTime": "A String", # Output only. The timestamp when the import job was created.
"displayName": "A String", # Optional. User-friendly display name. Maximum length is 256 characters.
"executionReport": { # A resource that reports result of the import job execution. # Output only. The report with the results of running the import job.
"executionErrors": { # A resource that aggregates errors across import job files. # Validation errors encountered during the execution of the import job.
"fileValidations": [ # List of errors found in files.
{ # A resource that aggregates the validation errors found in an import job file.
"fileErrors": [ # List of file level errors.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
"fileName": "A String", # The name of the file.
"partialReport": True or False, # Flag indicating that processing was aborted due to maximum number of errors.
"rowErrors": [ # Partial list of rows that encountered validation error.
{ # A resource that reports the import job errors at row level.
"csvError": { # Error details for a CSV file. # Error details for a CSV file.
"rowNumber": 42, # The row number where the error was detected.
},
"errors": [ # The list of errors detected in the row.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
"rowNumber": 42, # The row number where the error was detected.
"vmName": "A String", # The name of the VM in the row.
"vmUuid": "A String", # The VM UUID.
"xlsxError": { # Error details for an XLSX file. # Error details for an XLSX file.
"rowNumber": 42, # The row number where the error was detected.
"sheet": "A String", # The name of the sheet where the error was detected.
},
},
],
},
],
"jobErrors": [ # List of job level errors.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
},
"framesReported": 42, # Total number of asset frames reported for the import job.
"totalRowsCount": 42, # Output only. Total number of rows in the import job.
},
"labels": { # Labels as key value pairs.
"a_key": "A String",
},
"name": "A String", # Output only. The full name of the import job.
"state": "A String", # Output only. The state of the import job.
"updateTime": "A String", # Output only. The timestamp when the import job was last updated.
"validationReport": { # A resource that aggregates errors across import job files. # Output only. The report with the validation results of the import job.
"fileValidations": [ # List of errors found in files.
{ # A resource that aggregates the validation errors found in an import job file.
"fileErrors": [ # List of file level errors.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
"fileName": "A String", # The name of the file.
"partialReport": True or False, # Flag indicating that processing was aborted due to maximum number of errors.
"rowErrors": [ # Partial list of rows that encountered validation error.
{ # A resource that reports the import job errors at row level.
"csvError": { # Error details for a CSV file. # Error details for a CSV file.
"rowNumber": 42, # The row number where the error was detected.
},
"errors": [ # The list of errors detected in the row.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
"rowNumber": 42, # The row number where the error was detected.
"vmName": "A String", # The name of the VM in the row.
"vmUuid": "A String", # The VM UUID.
"xlsxError": { # Error details for an XLSX file. # Error details for an XLSX file.
"rowNumber": 42, # The row number where the error was detected.
"sheet": "A String", # The name of the sheet where the error was detected.
},
},
],
},
],
"jobErrors": [ # List of job level errors.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
},
}
importJobId: string, Required. ID of the import job.
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).
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, force=None, requestId=None, x__xgafv=None)
Deletes an import job.
Args:
name: string, Required. Name of the resource. (required)
force: boolean, Optional. If set to `true`, any `ImportDataFiles` of this job will also be deleted If set to `false`, the request only works if the job has no data files.
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, view=None, x__xgafv=None)
Gets the details of an import job.
Args:
name: string, Required. Name of the resource. (required)
view: string, Optional. The level of details of the import job. Default value is FULL.
Allowed values
IMPORT_JOB_VIEW_UNSPECIFIED - The import job view is not specified. The API displays the basic view by default.
IMPORT_JOB_VIEW_BASIC - The import job view includes basic metadata of an import job. This view does not include payload information.
IMPORT_JOB_VIEW_FULL - The import job view includes all metadata of an import job.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A resource that represents the background job that imports asset frames.
"assetSource": "A String", # Required. Reference to a source.
"completeTime": "A String", # Output only. The timestamp when the import job was completed.
"createTime": "A String", # Output only. The timestamp when the import job was created.
"displayName": "A String", # Optional. User-friendly display name. Maximum length is 256 characters.
"executionReport": { # A resource that reports result of the import job execution. # Output only. The report with the results of running the import job.
"executionErrors": { # A resource that aggregates errors across import job files. # Validation errors encountered during the execution of the import job.
"fileValidations": [ # List of errors found in files.
{ # A resource that aggregates the validation errors found in an import job file.
"fileErrors": [ # List of file level errors.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
"fileName": "A String", # The name of the file.
"partialReport": True or False, # Flag indicating that processing was aborted due to maximum number of errors.
"rowErrors": [ # Partial list of rows that encountered validation error.
{ # A resource that reports the import job errors at row level.
"csvError": { # Error details for a CSV file. # Error details for a CSV file.
"rowNumber": 42, # The row number where the error was detected.
},
"errors": [ # The list of errors detected in the row.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
"rowNumber": 42, # The row number where the error was detected.
"vmName": "A String", # The name of the VM in the row.
"vmUuid": "A String", # The VM UUID.
"xlsxError": { # Error details for an XLSX file. # Error details for an XLSX file.
"rowNumber": 42, # The row number where the error was detected.
"sheet": "A String", # The name of the sheet where the error was detected.
},
},
],
},
],
"jobErrors": [ # List of job level errors.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
},
"framesReported": 42, # Total number of asset frames reported for the import job.
"totalRowsCount": 42, # Output only. Total number of rows in the import job.
},
"labels": { # Labels as key value pairs.
"a_key": "A String",
},
"name": "A String", # Output only. The full name of the import job.
"state": "A String", # Output only. The state of the import job.
"updateTime": "A String", # Output only. The timestamp when the import job was last updated.
"validationReport": { # A resource that aggregates errors across import job files. # Output only. The report with the validation results of the import job.
"fileValidations": [ # List of errors found in files.
{ # A resource that aggregates the validation errors found in an import job file.
"fileErrors": [ # List of file level errors.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
"fileName": "A String", # The name of the file.
"partialReport": True or False, # Flag indicating that processing was aborted due to maximum number of errors.
"rowErrors": [ # Partial list of rows that encountered validation error.
{ # A resource that reports the import job errors at row level.
"csvError": { # Error details for a CSV file. # Error details for a CSV file.
"rowNumber": 42, # The row number where the error was detected.
},
"errors": [ # The list of errors detected in the row.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
"rowNumber": 42, # The row number where the error was detected.
"vmName": "A String", # The name of the VM in the row.
"vmUuid": "A String", # The VM UUID.
"xlsxError": { # Error details for an XLSX file. # Error details for an XLSX file.
"rowNumber": 42, # The row number where the error was detected.
"sheet": "A String", # The name of the sheet where the error was detected.
},
},
],
},
],
"jobErrors": [ # List of job level errors.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
},
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists all import jobs.
Args:
parent: string, Required. Parent value for `ListImportJobsRequest`. (required)
filter: string, Filtering results.
orderBy: string, Field to sort by. See https://google.aip.dev/132#ordering for more details.
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.
view: string, Optional. The level of details of each import job. Default value is BASIC.
Allowed values
IMPORT_JOB_VIEW_UNSPECIFIED - The import job view is not specified. The API displays the basic view by default.
IMPORT_JOB_VIEW_BASIC - The import job view includes basic metadata of an import job. This view does not include payload information.
IMPORT_JOB_VIEW_FULL - The import job view includes all metadata of an import job.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A response for listing import jobs.
"importJobs": [ # The list of import jobs.
{ # A resource that represents the background job that imports asset frames.
"assetSource": "A String", # Required. Reference to a source.
"completeTime": "A String", # Output only. The timestamp when the import job was completed.
"createTime": "A String", # Output only. The timestamp when the import job was created.
"displayName": "A String", # Optional. User-friendly display name. Maximum length is 256 characters.
"executionReport": { # A resource that reports result of the import job execution. # Output only. The report with the results of running the import job.
"executionErrors": { # A resource that aggregates errors across import job files. # Validation errors encountered during the execution of the import job.
"fileValidations": [ # List of errors found in files.
{ # A resource that aggregates the validation errors found in an import job file.
"fileErrors": [ # List of file level errors.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
"fileName": "A String", # The name of the file.
"partialReport": True or False, # Flag indicating that processing was aborted due to maximum number of errors.
"rowErrors": [ # Partial list of rows that encountered validation error.
{ # A resource that reports the import job errors at row level.
"csvError": { # Error details for a CSV file. # Error details for a CSV file.
"rowNumber": 42, # The row number where the error was detected.
},
"errors": [ # The list of errors detected in the row.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
"rowNumber": 42, # The row number where the error was detected.
"vmName": "A String", # The name of the VM in the row.
"vmUuid": "A String", # The VM UUID.
"xlsxError": { # Error details for an XLSX file. # Error details for an XLSX file.
"rowNumber": 42, # The row number where the error was detected.
"sheet": "A String", # The name of the sheet where the error was detected.
},
},
],
},
],
"jobErrors": [ # List of job level errors.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
},
"framesReported": 42, # Total number of asset frames reported for the import job.
"totalRowsCount": 42, # Output only. Total number of rows in the import job.
},
"labels": { # Labels as key value pairs.
"a_key": "A String",
},
"name": "A String", # Output only. The full name of the import job.
"state": "A String", # Output only. The state of the import job.
"updateTime": "A String", # Output only. The timestamp when the import job was last updated.
"validationReport": { # A resource that aggregates errors across import job files. # Output only. The report with the validation results of the import job.
"fileValidations": [ # List of errors found in files.
{ # A resource that aggregates the validation errors found in an import job file.
"fileErrors": [ # List of file level errors.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
"fileName": "A String", # The name of the file.
"partialReport": True or False, # Flag indicating that processing was aborted due to maximum number of errors.
"rowErrors": [ # Partial list of rows that encountered validation error.
{ # A resource that reports the import job errors at row level.
"csvError": { # Error details for a CSV file. # Error details for a CSV file.
"rowNumber": 42, # The row number where the error was detected.
},
"errors": [ # The list of errors detected in the row.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
"rowNumber": 42, # The row number where the error was detected.
"vmName": "A String", # The name of the VM in the row.
"vmUuid": "A String", # The VM UUID.
"xlsxError": { # Error details for an XLSX file. # Error details for an XLSX file.
"rowNumber": 42, # The row number where the error was detected.
"sheet": "A String", # The name of the sheet where the error was detected.
},
},
],
},
],
"jobErrors": [ # List of job level errors.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
},
},
],
"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 an import job.
Args:
name: string, Output only. The full name of the import job. (required)
body: object, The request body.
The object takes the form of:
{ # A resource that represents the background job that imports asset frames.
"assetSource": "A String", # Required. Reference to a source.
"completeTime": "A String", # Output only. The timestamp when the import job was completed.
"createTime": "A String", # Output only. The timestamp when the import job was created.
"displayName": "A String", # Optional. User-friendly display name. Maximum length is 256 characters.
"executionReport": { # A resource that reports result of the import job execution. # Output only. The report with the results of running the import job.
"executionErrors": { # A resource that aggregates errors across import job files. # Validation errors encountered during the execution of the import job.
"fileValidations": [ # List of errors found in files.
{ # A resource that aggregates the validation errors found in an import job file.
"fileErrors": [ # List of file level errors.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
"fileName": "A String", # The name of the file.
"partialReport": True or False, # Flag indicating that processing was aborted due to maximum number of errors.
"rowErrors": [ # Partial list of rows that encountered validation error.
{ # A resource that reports the import job errors at row level.
"csvError": { # Error details for a CSV file. # Error details for a CSV file.
"rowNumber": 42, # The row number where the error was detected.
},
"errors": [ # The list of errors detected in the row.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
"rowNumber": 42, # The row number where the error was detected.
"vmName": "A String", # The name of the VM in the row.
"vmUuid": "A String", # The VM UUID.
"xlsxError": { # Error details for an XLSX file. # Error details for an XLSX file.
"rowNumber": 42, # The row number where the error was detected.
"sheet": "A String", # The name of the sheet where the error was detected.
},
},
],
},
],
"jobErrors": [ # List of job level errors.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
},
"framesReported": 42, # Total number of asset frames reported for the import job.
"totalRowsCount": 42, # Output only. Total number of rows in the import job.
},
"labels": { # Labels as key value pairs.
"a_key": "A String",
},
"name": "A String", # Output only. The full name of the import job.
"state": "A String", # Output only. The state of the import job.
"updateTime": "A String", # Output only. The timestamp when the import job was last updated.
"validationReport": { # A resource that aggregates errors across import job files. # Output only. The report with the validation results of the import job.
"fileValidations": [ # List of errors found in files.
{ # A resource that aggregates the validation errors found in an import job file.
"fileErrors": [ # List of file level errors.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
"fileName": "A String", # The name of the file.
"partialReport": True or False, # Flag indicating that processing was aborted due to maximum number of errors.
"rowErrors": [ # Partial list of rows that encountered validation error.
{ # A resource that reports the import job errors at row level.
"csvError": { # Error details for a CSV file. # Error details for a CSV file.
"rowNumber": 42, # The row number where the error was detected.
},
"errors": [ # The list of errors detected in the row.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
"rowNumber": 42, # The row number where the error was detected.
"vmName": "A String", # The name of the VM in the row.
"vmUuid": "A String", # The VM UUID.
"xlsxError": { # Error details for an XLSX file. # Error details for an XLSX file.
"rowNumber": 42, # The row number where the error was detected.
"sheet": "A String", # The name of the sheet where the error was detected.
},
},
],
},
],
"jobErrors": [ # List of job level errors.
{ # A resource that reports the errors encountered while processing an import job.
"errorDetails": "A String", # The error information.
"severity": "A String", # The severity of the error.
},
],
},
}
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 `Asset` resource by the update. The values specified in the `update_mask` field are relative to the resource, not the full request. A field will be overwritten if it is in the mask. A single * value in the mask lets you to overwrite all fields.
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.
},
}
run(name, body=None, x__xgafv=None)
Runs an import job.
Args:
name: string, Required. The name of the import job to run. (required)
body: object, The request body.
The object takes the form of:
{ # A request to run an import job.
"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.
},
}
validate(name, body=None, x__xgafv=None)
Validates an import job.
Args:
name: string, Required. The name of the import job to validate. (required)
body: object, The request body.
The object takes the form of:
{ # A request to validate an import job.
"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.
},
}