Migration Center API . projects . locations . importJobs . importDataFiles

close()

Close httplib2 connections.

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

Creates an import data file.

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

{ # A resource that represents a payload file in an import job.
  "createTime": "A String", # Output only. The timestamp when the file was created.
  "displayName": "A String", # Optional. User-friendly display name. Maximum length is 256 characters.
  "format": "A String", # Required. The payload format.
  "name": "A String", # Output only. The name of the file.
  "state": "A String", # Output only. The state of the import data file.
  "uploadFileInfo": { # A resource that contains a URI to which a data file can be uploaded. # Information about a file that is uploaded to a storage service.
    "headers": { # Output only. The headers that were used to sign the URL.
      "a_key": "A String",
    },
    "signedUri": "A String", # Output only. Upload URI for the file.
    "uriExpirationTime": "A String", # Output only. Expiration time of the upload URI.
  },
}

  importDataFileId: string, Required. The ID of the new data file.
  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, requestId=None, x__xgafv=None)

Delete an import data file.

Args:
  name: string, Required. Name of the ImportDataFile to delete. (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 an import data file.

Args:
  name: string, Required. Name of the ImportDataFile. (required)
  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 a payload file in an import job.
  "createTime": "A String", # Output only. The timestamp when the file was created.
  "displayName": "A String", # Optional. User-friendly display name. Maximum length is 256 characters.
  "format": "A String", # Required. The payload format.
  "name": "A String", # Output only. The name of the file.
  "state": "A String", # Output only. The state of the import data file.
  "uploadFileInfo": { # A resource that contains a URI to which a data file can be uploaded. # Information about a file that is uploaded to a storage service.
    "headers": { # Output only. The headers that were used to sign the URL.
      "a_key": "A String",
    },
    "signedUri": "A String", # Output only. Upload URI for the file.
    "uriExpirationTime": "A String", # Output only. Expiration time of the upload URI.
  },
}

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

List import data files.

Args:
  parent: string, Required. Name of the parent of the `ImportDataFiles` resource. (required)
  filter: string, Filtering results.
  orderBy: string, Field to sort by. See https://google.aip.dev/132#ordering for more details.
  pageSize: integer, The maximum number of data files to return. The service may return fewer than this value. If unspecified, at most 500 data files will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, A page token, received from a previous `ListImportDataFiles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListImportDataFiles` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for listing payload files of an import job.
  "importDataFiles": [ # The list of import data files.
    { # A resource that represents a payload file in an import job.
      "createTime": "A String", # Output only. The timestamp when the file was created.
      "displayName": "A String", # Optional. User-friendly display name. Maximum length is 256 characters.
      "format": "A String", # Required. The payload format.
      "name": "A String", # Output only. The name of the file.
      "state": "A String", # Output only. The state of the import data file.
      "uploadFileInfo": { # A resource that contains a URI to which a data file can be uploaded. # Information about a file that is uploaded to a storage service.
        "headers": { # Output only. The headers that were used to sign the URL.
          "a_key": "A String",
        },
        "signedUri": "A String", # Output only. Upload URI for the file.
        "uriExpirationTime": "A String", # Output only. Expiration time of the upload URI.
      },
    },
  ],
  "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "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.