Package com.google.storagetransfer.v1.proto

Class TransferProto.ListTransferJobsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<TransferProto.ListTransferJobsRequest.Builder>
com.google.storagetransfer.v1.proto.TransferProto.ListTransferJobsRequest.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TransferProto.ListTransferJobsRequestOrBuilder, Cloneable
Enclosing class:
TransferProto.ListTransferJobsRequest
public static final class TransferProto.ListTransferJobsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<TransferProto.ListTransferJobsRequest.Builder> implements TransferProto.ListTransferJobsRequestOrBuilder
 `projectId`, `jobNames`, and `jobStatuses` are query parameters that can
 be specified when listing transfer jobs.
Protobuf type google.storagetransfer.v1.ListTransferJobsRequest

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<TransferProto.ListTransferJobsRequest.Builder>

    • clear

      public TransferProto.ListTransferJobsRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<TransferProto.ListTransferJobsRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<TransferProto.ListTransferJobsRequest.Builder>

    • getDefaultInstanceForType

      public TransferProto.ListTransferJobsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public TransferProto.ListTransferJobsRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public TransferProto.ListTransferJobsRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public TransferProto.ListTransferJobsRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TransferProto.ListTransferJobsRequest.Builder>

    • mergeFrom

      public TransferProto.ListTransferJobsRequest.Builder mergeFrom(TransferProto.ListTransferJobsRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<TransferProto.ListTransferJobsRequest.Builder>

    • mergeFrom

      public TransferProto.ListTransferJobsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TransferProto.ListTransferJobsRequest.Builder>
      Throws:
      IOException

    • getFilter

      public 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];
      Specified by:
      getFilter in interface TransferProto.ListTransferJobsRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public 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];
      Specified by:
      getFilterBytes in interface TransferProto.ListTransferJobsRequestOrBuilder
      Returns:
      The bytes for filter.

    • setFilter

      public TransferProto.ListTransferJobsRequest.Builder setFilter(String value)
       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];
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • clearFilter

      public TransferProto.ListTransferJobsRequest.Builder clearFilter()
       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:
      This builder for chaining.

    • setFilterBytes

      public TransferProto.ListTransferJobsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.

    • getPageSize

      public int getPageSize()
       The list page size. The max allowed value is 256.
      int32 page_size = 4;
      Specified by:
      getPageSize in interface TransferProto.ListTransferJobsRequestOrBuilder
      Returns:
      The pageSize.

    • setPageSize

      public TransferProto.ListTransferJobsRequest.Builder setPageSize(int value)
       The list page size. The max allowed value is 256.
      int32 page_size = 4;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public TransferProto.ListTransferJobsRequest.Builder clearPageSize()
       The list page size. The max allowed value is 256.
      int32 page_size = 4;
      Returns:
      This builder for chaining.

    • getPageToken

      public String getPageToken()
       The list page token.
      string page_token = 5;
      Specified by:
      getPageToken in interface TransferProto.ListTransferJobsRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       The list page token.
      string page_token = 5;
      Specified by:
      getPageTokenBytes in interface TransferProto.ListTransferJobsRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • setPageToken

      public TransferProto.ListTransferJobsRequest.Builder setPageToken(String value)
       The list page token.
      string page_token = 5;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public TransferProto.ListTransferJobsRequest.Builder clearPageToken()
       The list page token.
      string page_token = 5;
      Returns:
      This builder for chaining.

    • setPageTokenBytes

      public TransferProto.ListTransferJobsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       The list page token.
      string page_token = 5;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.