Package com.google.storagetransfer.v1.proto

Class TransferProto.UpdateTransferJobRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.storagetransfer.v1.proto.TransferProto.UpdateTransferJobRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TransferProto.UpdateTransferJobRequestOrBuilder, Serializable
Enclosing class:
TransferProto
public static final class TransferProto.UpdateTransferJobRequest extends com.google.protobuf.GeneratedMessage implements TransferProto.UpdateTransferJobRequestOrBuilder
 Request passed to UpdateTransferJob.
Protobuf type google.storagetransfer.v1.UpdateTransferJobRequest
See Also:

  • Field Details

    • JOB_NAME_FIELD_NUMBER

      public static final int JOB_NAME_FIELD_NUMBER
      See Also:

    • PROJECT_ID_FIELD_NUMBER

      public static final int PROJECT_ID_FIELD_NUMBER
      See Also:

    • TRANSFER_JOB_FIELD_NUMBER

      public static final int TRANSFER_JOB_FIELD_NUMBER
      See Also:

    • UPDATE_TRANSFER_JOB_FIELD_MASK_FIELD_NUMBER

      public static final int UPDATE_TRANSFER_JOB_FIELD_MASK_FIELD_NUMBER
      See Also:

  • 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

    • getJobName

      public String getJobName()
       Required. The name of job to update.
      string job_name = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getJobName in interface TransferProto.UpdateTransferJobRequestOrBuilder
      Returns:
      The jobName.

    • getJobNameBytes

      public com.google.protobuf.ByteString getJobNameBytes()
       Required. The name of job to update.
      string job_name = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getJobNameBytes in interface TransferProto.UpdateTransferJobRequestOrBuilder
      Returns:
      The bytes for jobName.

    • getProjectId

      public String getProjectId()
       Required. The ID of the Google Cloud project that owns the
 job.
      string project_id = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getProjectId in interface TransferProto.UpdateTransferJobRequestOrBuilder
      Returns:
      The projectId.

    • getProjectIdBytes

      public com.google.protobuf.ByteString getProjectIdBytes()
       Required. The ID of the Google Cloud project that owns the
 job.
      string project_id = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getProjectIdBytes in interface TransferProto.UpdateTransferJobRequestOrBuilder
      Returns:
      The bytes for projectId.

    • hasTransferJob

      public boolean hasTransferJob()
       Required. The job to update. `transferJob` is expected to specify one or
 more of five fields:
 [description][google.storagetransfer.v1.TransferJob.description],
 [transfer_spec][google.storagetransfer.v1.TransferJob.transfer_spec],
 [notification_config][google.storagetransfer.v1.TransferJob.notification_config],
 [logging_config][google.storagetransfer.v1.TransferJob.logging_config], and
 [status][google.storagetransfer.v1.TransferJob.status].  An
 `UpdateTransferJobRequest` that specifies other fields are rejected with
 the error [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. Updating a
 job status to
 [DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED] requires
 `storagetransfer.jobs.delete` permission.
      .google.storagetransfer.v1.TransferJob transfer_job = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasTransferJob in interface TransferProto.UpdateTransferJobRequestOrBuilder
      Returns:
      Whether the transferJob field is set.

    • getTransferJob

      public TransferTypes.TransferJob getTransferJob()
       Required. The job to update. `transferJob` is expected to specify one or
 more of five fields:
 [description][google.storagetransfer.v1.TransferJob.description],
 [transfer_spec][google.storagetransfer.v1.TransferJob.transfer_spec],
 [notification_config][google.storagetransfer.v1.TransferJob.notification_config],
 [logging_config][google.storagetransfer.v1.TransferJob.logging_config], and
 [status][google.storagetransfer.v1.TransferJob.status].  An
 `UpdateTransferJobRequest` that specifies other fields are rejected with
 the error [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. Updating a
 job status to
 [DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED] requires
 `storagetransfer.jobs.delete` permission.
      .google.storagetransfer.v1.TransferJob transfer_job = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getTransferJob in interface TransferProto.UpdateTransferJobRequestOrBuilder
      Returns:
      The transferJob.

    • getTransferJobOrBuilder

      public TransferTypes.TransferJobOrBuilder getTransferJobOrBuilder()
       Required. The job to update. `transferJob` is expected to specify one or
 more of five fields:
 [description][google.storagetransfer.v1.TransferJob.description],
 [transfer_spec][google.storagetransfer.v1.TransferJob.transfer_spec],
 [notification_config][google.storagetransfer.v1.TransferJob.notification_config],
 [logging_config][google.storagetransfer.v1.TransferJob.logging_config], and
 [status][google.storagetransfer.v1.TransferJob.status].  An
 `UpdateTransferJobRequest` that specifies other fields are rejected with
 the error [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. Updating a
 job status to
 [DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED] requires
 `storagetransfer.jobs.delete` permission.
      .google.storagetransfer.v1.TransferJob transfer_job = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getTransferJobOrBuilder in interface TransferProto.UpdateTransferJobRequestOrBuilder

    • hasUpdateTransferJobFieldMask

      public boolean hasUpdateTransferJobFieldMask()
       The field mask of the fields in `transferJob` that are to be updated in
 this request.  Fields in `transferJob` that can be updated are:
 [description][google.storagetransfer.v1.TransferJob.description],
 [transfer_spec][google.storagetransfer.v1.TransferJob.transfer_spec],
 [notification_config][google.storagetransfer.v1.TransferJob.notification_config],
 [logging_config][google.storagetransfer.v1.TransferJob.logging_config], and
 [status][google.storagetransfer.v1.TransferJob.status].  To update the
 `transfer_spec` of the job, a complete transfer specification must be
 provided. An incomplete specification missing any required fields is
 rejected with the error
 [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT].
      .google.protobuf.FieldMask update_transfer_job_field_mask = 4;
      Specified by:
      hasUpdateTransferJobFieldMask in interface TransferProto.UpdateTransferJobRequestOrBuilder
      Returns:
      Whether the updateTransferJobFieldMask field is set.

    • getUpdateTransferJobFieldMask

      public com.google.protobuf.FieldMask getUpdateTransferJobFieldMask()
       The field mask of the fields in `transferJob` that are to be updated in
 this request.  Fields in `transferJob` that can be updated are:
 [description][google.storagetransfer.v1.TransferJob.description],
 [transfer_spec][google.storagetransfer.v1.TransferJob.transfer_spec],
 [notification_config][google.storagetransfer.v1.TransferJob.notification_config],
 [logging_config][google.storagetransfer.v1.TransferJob.logging_config], and
 [status][google.storagetransfer.v1.TransferJob.status].  To update the
 `transfer_spec` of the job, a complete transfer specification must be
 provided. An incomplete specification missing any required fields is
 rejected with the error
 [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT].
      .google.protobuf.FieldMask update_transfer_job_field_mask = 4;
      Specified by:
      getUpdateTransferJobFieldMask in interface TransferProto.UpdateTransferJobRequestOrBuilder
      Returns:
      The updateTransferJobFieldMask.

    • getUpdateTransferJobFieldMaskOrBuilder

      public com.google.protobuf.FieldMaskOrBuilder getUpdateTransferJobFieldMaskOrBuilder()
       The field mask of the fields in `transferJob` that are to be updated in
 this request.  Fields in `transferJob` that can be updated are:
 [description][google.storagetransfer.v1.TransferJob.description],
 [transfer_spec][google.storagetransfer.v1.TransferJob.transfer_spec],
 [notification_config][google.storagetransfer.v1.TransferJob.notification_config],
 [logging_config][google.storagetransfer.v1.TransferJob.logging_config], and
 [status][google.storagetransfer.v1.TransferJob.status].  To update the
 `transfer_spec` of the job, a complete transfer specification must be
 provided. An incomplete specification missing any required fields is
 rejected with the error
 [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT].
      .google.protobuf.FieldMask update_transfer_job_field_mask = 4;
      Specified by:
      getUpdateTransferJobFieldMaskOrBuilder in interface TransferProto.UpdateTransferJobRequestOrBuilder

    • 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.UpdateTransferJobRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static TransferProto.UpdateTransferJobRequest 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.UpdateTransferJobRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static TransferProto.UpdateTransferJobRequest.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static TransferProto.UpdateTransferJobRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<TransferProto.UpdateTransferJobRequest> 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.UpdateTransferJobRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder