Reference documentation and code samples for the BigQuery Data Transfer Service V1 API class Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsRequest.
A request to list data transfer runs.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#page_size
def page_size() -> ::Integer
Returns
- (::Integer) — Page size. The default page size is the maximum value of 1000 results.
#page_size=
def page_size=(value) -> ::Integer
Parameter
- value (::Integer) — Page size. The default page size is the maximum value of 1000 results.
Returns
- (::Integer) — Page size. The default page size is the maximum value of 1000 results.
#page_token
def page_token() -> ::String
Returns
-
(::String) — Pagination token, which can be used to request a specific page
of
ListTransferRunsRequest
list results. For multiple-page results,ListTransferRunsResponse
outputs anext_page
token, which can be used as thepage_token
value to request the next page of list results.
#page_token=
def page_token=(value) -> ::String
Parameter
-
value (::String) — Pagination token, which can be used to request a specific page
of
ListTransferRunsRequest
list results. For multiple-page results,ListTransferRunsResponse
outputs anext_page
token, which can be used as thepage_token
value to request the next page of list results.
Returns
-
(::String) — Pagination token, which can be used to request a specific page
of
ListTransferRunsRequest
list results. For multiple-page results,ListTransferRunsResponse
outputs anext_page
token, which can be used as thepage_token
value to request the next page of list results.
#parent
def parent() -> ::String
Returns
-
(::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}
orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}
.
#parent=
def parent=(value) -> ::String
Parameter
-
value (::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}
orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}
.
Returns
-
(::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}
orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}
.
#run_attempt
def run_attempt() -> ::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsRequest::RunAttempt
Returns
- (::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsRequest::RunAttempt) — Indicates how run attempts are to be pulled.
#run_attempt=
def run_attempt=(value) -> ::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsRequest::RunAttempt
Parameter
- value (::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsRequest::RunAttempt) — Indicates how run attempts are to be pulled.
Returns
- (::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsRequest::RunAttempt) — Indicates how run attempts are to be pulled.
#states
def states() -> ::Array<::Google::Cloud::Bigquery::DataTransfer::V1::TransferState>
Returns
- (::Array<::Google::Cloud::Bigquery::DataTransfer::V1::TransferState>) — When specified, only transfer runs with requested states are returned.
#states=
def states=(value) -> ::Array<::Google::Cloud::Bigquery::DataTransfer::V1::TransferState>
Parameter
- value (::Array<::Google::Cloud::Bigquery::DataTransfer::V1::TransferState>) — When specified, only transfer runs with requested states are returned.
Returns
- (::Array<::Google::Cloud::Bigquery::DataTransfer::V1::TransferState>) — When specified, only transfer runs with requested states are returned.