Package com.google.storagetransfer.v1.proto

Interface TransferProto.ListTransferJobsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
TransferProto.ListTransferJobsRequest, TransferProto.ListTransferJobsRequest.Builder
Enclosing class:
TransferProto
public static interface TransferProto.ListTransferJobsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    Required.
    com.google.protobuf.ByteString
    getFilterBytes()
    Required.
    int
    getPageSize()
    The list page size.
    String
    getPageToken()
    The list page token.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    The list page token.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getFilter

      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][google.storagetransfer.v1.TransferJob.Status.ENABLED]
 * [DISABLED][google.storagetransfer.v1.TransferJob.Status.DISABLED]
 * [DELETED][google.storagetransfer.v1.TransferJob.Status.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:
      The filter.

    • getFilterBytes

      com.google.protobuf.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][google.storagetransfer.v1.TransferJob.Status.ENABLED]
 * [DISABLED][google.storagetransfer.v1.TransferJob.Status.DISABLED]
 * [DELETED][google.storagetransfer.v1.TransferJob.Status.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:
      The bytes for filter.

    • getPageSize

      int getPageSize()
       The list page size. The max allowed value is 256.
      int32 page_size = 4;
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       The list page token.
      string page_token = 5;
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       The list page token.
      string page_token = 5;
      Returns:
      The bytes for pageToken.