close()

Close httplib2 connections.

delete(name, x__xgafv=None)

Deletes the specified transfer run.

Args:
  name: string, Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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 `{}`.
}

get(name, x__xgafv=None)

Returns information about the particular transfer run.

Args:
name: string, Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Represents a data transfer run.
"dataSourceId": "A String", # Output only. Data source id.
"destinationDatasetId": "A String", # Output only. The BigQuery target dataset id.
"emailPreferences": { # Represents preferences for sending email notifications for transfer run events. # Output only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from.
"enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
},
"endTime": "A String", # Output only. Time when transfer run ended. Parameter ignored by server for input requests.
"errorStatus": { # 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). # Status of the transfer run.
"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.
},
"name": "A String", # The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run.
"notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project}/topics/{topic}`
"params": { # Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
"a_key": "", # Properties of the object.
},
"runTime": "A String", # For batch transfer runs, specifies the date and time of the data should be ingested.
"schedule": "A String", # Output only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, so `schedule_time` doesn't always match this.
"scheduleTime": "A String", # Minimum time after which a transfer run can be started.
"startTime": "A String", # Output only. Time when transfer run was started. Parameter ignored by server for input requests.
"state": "A String", # Data transfer run state. Ignored for input requests.
"updateTime": "A String", # Output only. Last time the data transfer run state was updated.
"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
}

list(parent, pageSize=None, pageToken=None, runAttempt=None, states=None, x__xgafv=None)

Returns information about running and completed jobs.

Args:
parent: string, Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. (required)
pageSize: integer, Page size. The default page size is the maximum value of 1000 results.
pageToken: string, Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
runAttempt: string, Indicates how run attempts are to be pulled.
Allowed values
RUN_ATTEMPT_UNSPECIFIED - All runs should be returned.
LATEST - Only latest run per day should be returned.
states: string, When specified, only transfer runs with requested states are returned. (repeated)
Allowed values
TRANSFER_STATE_UNSPECIFIED - State placeholder (0).
PENDING - Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).
RUNNING - Data transfer is in progress (3).
SUCCEEDED - Data transfer completed successfully (4).
FAILED - Data transfer failed (5).
CANCELLED - Data transfer is cancelled (6).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # The returned list of pipelines in the project.
"nextPageToken": "A String", # Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferRunsRequest.page_token` to request the next page of list results.
"transferRuns": [ # Output only. The stored pipeline transfer runs.
{ # Represents a data transfer run.
"dataSourceId": "A String", # Output only. Data source id.
"destinationDatasetId": "A String", # Output only. The BigQuery target dataset id.
"emailPreferences": { # Represents preferences for sending email notifications for transfer run events. # Output only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from.
"enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.
},
"endTime": "A String", # Output only. Time when transfer run ended. Parameter ignored by server for input requests.
"errorStatus": { # 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). # Status of the transfer run.
"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.
},
"name": "A String", # The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run.
"notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project}/topics/{topic}`
"params": { # Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
"a_key": "", # Properties of the object.
},
"runTime": "A String", # For batch transfer runs, specifies the date and time of the data should be ingested.
"schedule": "A String", # Output only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, so `schedule_time` doesn't always match this.
"scheduleTime": "A String", # Minimum time after which a transfer run can be started.
"startTime": "A String", # Output only. Time when transfer run was started. Parameter ignored by server for input requests.
"state": "A String", # Data transfer run state. Ignored for input requests.
"updateTime": "A String", # Output only. Last time the data transfer run state was updated.
"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.
},
],
}

list_next(previous_request, previous_response)

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.

BigQuery Data Transfer API . projects . transferConfigs . runs

Instance Methods

Method Details