Interface TransferProto.ListTransferJobsRequestOrBuilder (1.56.0)

public static interface TransferProto.ListTransferJobsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

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:
    • ENABLED
    • DISABLED
    • DELETED
  • 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`.

    string filter = 1 [(.google.api.field_behavior) = REQUIRED];

    Returns
    Type Description
    String

    The filter.

    getFilterBytes()

    public abstract ByteString getFilterBytes()

    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:
    • ENABLED
    • DISABLED
    • DELETED
  • 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`.

    string filter = 1 [(.google.api.field_behavior) = REQUIRED];

    Returns
    Type Description
    ByteString

    The bytes for filter.

    getPageSize()

    public abstract int getPageSize()

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

    int32 page_size = 4;

    Returns
    Type Description
    int

    The pageSize.

    getPageToken()

    public abstract String getPageToken()

    The list page token.

    string page_token = 5;

    Returns
    Type Description
    String

    The pageToken.

    getPageTokenBytes()

    public abstract ByteString getPageTokenBytes()

    The list page token.

    string page_token = 5;

    Returns
    Type Description
    ByteString

    The bytes for pageToken.