Class: Google::Cloud::StorageTransfer::V1::ListTransferJobsRequest

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

Overview

projectId, jobNames, and jobStatuses are query parameters that can be specified when listing transfer jobs.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns Required. A list of query parameters specified as JSON text in the form of:

{
  "projectId":"my_project_id",
  "jobNames":["jobid1","jobid2",...],
  "jobStatuses":["status1","status2",...],
  "dataBackend":"QUERY_REPLICATION_CONFIGS",
  "sourceBucket":"source-bucket-name",
  "sinkBucket":"sink-bucket-name",
}

The JSON formatting in the example is for display only; provide the query parameters without spaces or line breaks.

  • projectId is required.
  • Since jobNames and jobStatuses support multiple values, their values must be specified with array notation. jobNames and jobStatuses are optional. Valid values are case-insensitive:
  • Specify "dataBackend":"QUERY_REPLICATION_CONFIGS" to return a list of cross-bucket replication jobs.
  • Limit the results to jobs from a particular bucket with sourceBucket and/or to a particular bucket with sinkBucket.

Returns:

  • (::String) —

    Required. A list of query parameters specified as JSON text in the form of:

    {
  "projectId":"my_project_id",
  "jobNames":["jobid1","jobid2",...],
  "jobStatuses":["status1","status2",...],
  "dataBackend":"QUERY_REPLICATION_CONFIGS",
  "sourceBucket":"source-bucket-name",
  "sinkBucket":"sink-bucket-name",
}

    The JSON formatting in the example is for display only; provide the query parameters without spaces or line breaks.

    • projectId is required.
    • Since jobNames and jobStatuses support multiple values, their values must be specified with array notation. jobNames and jobStatuses are optional. Valid values are case-insensitive:
    • Specify "dataBackend":"QUERY_REPLICATION_CONFIGS" to return a list of cross-bucket replication jobs.
    • Limit the results to jobs from a particular bucket with sourceBucket and/or to a particular bucket with sinkBucket.


146
147
148
149
 
# File 'proto_docs/google/storagetransfer/v1/transfer.rb', line 146

class ListTransferJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns The list page size. The max allowed value is 256.

Returns:

  • (::Integer) —

    The list page size. The max allowed value is 256.



146
147
148
149
 
# File 'proto_docs/google/storagetransfer/v1/transfer.rb', line 146

class ListTransferJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns The list page token.

Returns:

  • (::String) —

    The list page token.



146
147
148
149
 
# File 'proto_docs/google/storagetransfer/v1/transfer.rb', line 146

class ListTransferJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end