Storage Transfer Service V1 API - Class Google::Cloud::StorageTransfer::V1::ListTransferJobsRequest (v1.8.0)

Reference documentation and code samples for the Storage Transfer Service V1 API class Google::Cloud::StorageTransfer::V1::ListTransferJobsRequest.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
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.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::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.
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.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — The list page size. The max allowed value is 256.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — The list page size. The max allowed value is 256.
Returns
  • (::Integer) — The list page size. The max allowed value is 256.

#page_token

def page_token() -> ::String
Returns
  • (::String) — The list page token.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — The list page token.
Returns
  • (::String) — The list page token.