Class: Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/data_transfer/v1/data_transfer.rb

Overview

A request to list data transfer runs. UI can use this method to show/filter specific data transfer runs. The data source can use this method to request all scheduled transfer runs.

Defined Under Namespace

Modules: RunAttempt

Instance Attribute Summary collapse

Instance Attribute Details

#page_size ⇒ Integer

Returns 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.



402
403
404
405
406
407
408
409
410
411
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/data_transfer/v1/data_transfer.rb', line 402

class ListTransferRunsRequest
  # Represents which runs should be pulled.
  module RunAttempt
    # All runs should be returned.
    RUN_ATTEMPT_UNSPECIFIED = 0

    # Only latest run per day should be returned.
    LATEST = 1
  end
end

#page_token ⇒ String

Returns 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.

Returns:

  • (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.



402
403
404
405
406
407
408
409
410
411
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/data_transfer/v1/data_transfer.rb', line 402

class ListTransferRunsRequest
  # Represents which runs should be pulled.
  module RunAttempt
    # All runs should be returned.
    RUN_ATTEMPT_UNSPECIFIED = 0

    # Only latest run per day should be returned.
    LATEST = 1
  end
end

#parent ⇒ String

Returns Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: +projects/{project_id}/transferConfigs/{config_id}+.

Returns:

  • (String) —

    Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: +projects/{project_id}/transferConfigs/{config_id}+.



402
403
404
405
406
407
408
409
410
411
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/data_transfer/v1/data_transfer.rb', line 402

class ListTransferRunsRequest
  # Represents which runs should be pulled.
  module RunAttempt
    # All runs should be returned.
    RUN_ATTEMPT_UNSPECIFIED = 0

    # Only latest run per day should be returned.
    LATEST = 1
  end
end

#run_attempt ⇒ Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsRequest::RunAttempt

Returns Indicates how run attempts are to be pulled.

Returns:



402
403
404
405
406
407
408
409
410
411
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/data_transfer/v1/data_transfer.rb', line 402

class ListTransferRunsRequest
  # Represents which runs should be pulled.
  module RunAttempt
    # All runs should be returned.
    RUN_ATTEMPT_UNSPECIFIED = 0

    # Only latest run per day should be returned.
    LATEST = 1
  end
end

#states ⇒ Array<Google::Cloud::Bigquery::DataTransfer::V1::TransferState>

Returns When specified, only transfer runs with requested states are returned.

Returns:



402
403
404
405
406
407
408
409
410
411
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/data_transfer/v1/data_transfer.rb', line 402

class ListTransferRunsRequest
  # Represents which runs should be pulled.
  module RunAttempt
    # All runs should be returned.
    RUN_ATTEMPT_UNSPECIFIED = 0

    # Only latest run per day should be returned.
    LATEST = 1
  end
end