Package com.google.storagetransfer.v1.proto

Class TransferProto.ListTransferJobsRequest

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

  • Field Details

  • 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

    • 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.

    • 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.

    • 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.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static TransferProto.ListTransferJobsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferProto.ListTransferJobsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferProto.ListTransferJobsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferProto.ListTransferJobsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferProto.ListTransferJobsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferProto.ListTransferJobsRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferProto.ListTransferJobsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TransferProto.ListTransferJobsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TransferProto.ListTransferJobsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TransferProto.ListTransferJobsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TransferProto.ListTransferJobsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TransferProto.ListTransferJobsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static TransferProto.ListTransferJobsRequest.Builder newBuilder()

    • newBuilder

      public static TransferProto.ListTransferJobsRequest.Builder newBuilder(TransferProto.ListTransferJobsRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected TransferProto.ListTransferJobsRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static TransferProto.ListTransferJobsRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<TransferProto.ListTransferJobsRequest> parser()

    • getParserForType

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

    • getDefaultInstanceForType

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