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",...]}

Since jobNames and jobStatuses support multiple values, their values must be specified with array notation. projectId is required. jobNames and jobStatuses are optional. The valid values for jobStatuses are case-insensitive: ENABLED, DISABLED, and DELETED.

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",...]}

    Since jobNames and jobStatuses support multiple values, their values must be specified with array notation. projectId is required. jobNames and jobStatuses are optional. The valid values for jobStatuses are case-insensitive: ENABLED, DISABLED, and DELETED.



131
132
133
134
 
# File 'proto_docs/google/storagetransfer/v1/transfer.rb', line 131

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.



131
132
133
134
 
# File 'proto_docs/google/storagetransfer/v1/transfer.rb', line 131

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.



131
132
133
134
 
# File 'proto_docs/google/storagetransfer/v1/transfer.rb', line 131

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