BigQuery Data Transfer API . projects . locations . transferConfigs . transferResources

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Returns a transfer resource.

Args:
  name: string, Required. The name of the transfer resource in the form of: * `projects/{project}/transferConfigs/{transfer_config}/transferResources/{transfer_resource}` * `projects/{project}/locations/{location}/transferConfigs/{transfer_config}/transferResources/{transfer_resource}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Resource(table/partition) that is being transferred.
  "destination": "A String", # Optional. Resource destination.
  "hierarchyDetail": { # Details about the hierarchy. # Optional. Details about the hierarchy.
    "partitionDetail": { # Partition details related to hierarchy. # Optional. Partition details related to hierarchy.
      "table": "A String", # Optional. Name of the table which has the partitions.
    },
    "tableDetail": { # Table details related to hierarchy. # Optional. Table details related to hierarchy.
      "partitionCount": "A String", # Optional. Total number of partitions being tracked within the table.
    },
  },
  "lastSuccessfulRun": { # Basic information about a transfer run. # Output only. Run details for the last successful run.
    "run": "A String", # Optional. Run URI. Format projects/{project}/locations/{location}/transferConfigs/{config}/run/{run}
    "startTime": "A String", # Optional. Start time of the transfer run.
  },
  "latestRun": { # Basic information about a transfer run. # Optional. Run details for the latest run.
    "run": "A String", # Optional. Run URI. Format projects/{project}/locations/{location}/transferConfigs/{config}/run/{run}
    "startTime": "A String", # Optional. Start time of the transfer run.
  },
  "latestStatusDetail": { # Status details of the resource being transferred. # Optional. Status details for the latest run.
    "completedPercentage": 3.14, # Output only. Percentage of the transfer completed. Valid values: 0-100.
    "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). # Optional. Transfer error details for the resource.
      "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.
    },
    "state": "A String", # Optional. Transfer state of the resource.
    "summary": { # Status summary of the resource being transferred. # Optional. Transfer status summary of the resource.
      "metrics": [ # Optional. List of transfer status metrics.
        { # Metrics for tracking the transfer status.
          "completed": "A String", # Optional. Number of units transferred successfully.
          "failed": "A String", # Optional. Number of units that failed to transfer.
          "pending": "A String", # Optional. Number of units pending transfer.
          "total": "A String", # Optional. Total number of units for the transfer.
          "unit": "A String", # Optional. Unit for measuring progress (e.g., BYTES).
        },
      ],
      "progressUnit": "A String", # Input only. Unit based on which transfer status progress should be calculated.
    },
  },
  "name": "A String", # Identifier. Resource name.
  "type": "A String", # Optional. Resource type.
  "updateTime": "A String", # Output only. Time when the resource was last updated.
}

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

Returns information about transfer resources.

Args:
  parent: string, Required. Name of transfer configuration for which transfer resources should be retrieved. The name should be in one of the following form: * `projects/{project_id}/transferConfigs/{config_id}` * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` (required)
  filter: string, Optional. Filter for the transfer resources. Currently supported filters include: * Resource name: `name` - Wildcard supported * Resource type: `type` * Resource destination: `destination` * Latest resource state: `latest_status_detail.state` * Last update time: `update_time` - RFC-3339 format * Parent table name: `hierarchy_detail.partition_detail.table` Multiple filters can be applied using the `AND/OR` operator. Examples: * `name="*123" AND (type="TABLE" OR latest_status_detail.state="SUCCEEDED")` * `update_time >= "2012-04-21T11:30:00-04:00` * `hierarchy_detail.partition_detail.table = "table1"`
  pageSize: integer, Optional. The maximum number of transfer resources to return. The maximum value is 1000; values above 1000 will be coerced to 1000. The default page size is the maximum value of 1000 results.
  pageToken: string, Optional. A page token, received from a previous `ListTransferResources` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTransferResources` 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 the ListTransferResources RPC.
  "nextPageToken": "A String", # Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "transferResources": [ # Output only. The transfer resources.
    { # Resource(table/partition) that is being transferred.
      "destination": "A String", # Optional. Resource destination.
      "hierarchyDetail": { # Details about the hierarchy. # Optional. Details about the hierarchy.
        "partitionDetail": { # Partition details related to hierarchy. # Optional. Partition details related to hierarchy.
          "table": "A String", # Optional. Name of the table which has the partitions.
        },
        "tableDetail": { # Table details related to hierarchy. # Optional. Table details related to hierarchy.
          "partitionCount": "A String", # Optional. Total number of partitions being tracked within the table.
        },
      },
      "lastSuccessfulRun": { # Basic information about a transfer run. # Output only. Run details for the last successful run.
        "run": "A String", # Optional. Run URI. Format projects/{project}/locations/{location}/transferConfigs/{config}/run/{run}
        "startTime": "A String", # Optional. Start time of the transfer run.
      },
      "latestRun": { # Basic information about a transfer run. # Optional. Run details for the latest run.
        "run": "A String", # Optional. Run URI. Format projects/{project}/locations/{location}/transferConfigs/{config}/run/{run}
        "startTime": "A String", # Optional. Start time of the transfer run.
      },
      "latestStatusDetail": { # Status details of the resource being transferred. # Optional. Status details for the latest run.
        "completedPercentage": 3.14, # Output only. Percentage of the transfer completed. Valid values: 0-100.
        "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). # Optional. Transfer error details for the resource.
          "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.
        },
        "state": "A String", # Optional. Transfer state of the resource.
        "summary": { # Status summary of the resource being transferred. # Optional. Transfer status summary of the resource.
          "metrics": [ # Optional. List of transfer status metrics.
            { # Metrics for tracking the transfer status.
              "completed": "A String", # Optional. Number of units transferred successfully.
              "failed": "A String", # Optional. Number of units that failed to transfer.
              "pending": "A String", # Optional. Number of units pending transfer.
              "total": "A String", # Optional. Total number of units for the transfer.
              "unit": "A String", # Optional. Unit for measuring progress (e.g., BYTES).
            },
          ],
          "progressUnit": "A String", # Input only. Unit based on which transfer status progress should be calculated.
        },
      },
      "name": "A String", # Identifier. Resource name.
      "type": "A String", # Optional. Resource type.
      "updateTime": "A String", # Output only. Time when the resource was last updated.
    },
  ],
}

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.