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

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb

Overview

A request to list data 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.



516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 516

class ListTransferRunsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

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



516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 516

class ListTransferRunsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

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

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} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.



516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 516

class ListTransferRunsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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:



516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 516

class ListTransferRunsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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:



516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'proto_docs/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 516

class ListTransferRunsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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