Package com.google.storagetransfer.v1.proto

Class TransferProto.UpdateTransferJobRequest

    • Field Detail

      • PROJECT_ID_FIELD_NUMBER

        public static final int PROJECT_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRANSFER_JOB_FIELD_NUMBER

        public static final int TRANSFER_JOB_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPDATE_TRANSFER_JOB_FIELD_MASK_FIELD_NUMBER

        public static final int UPDATE_TRANSFER_JOB_FIELD_MASK_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

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

      • newBuilderForType

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

      • newBuilderForType

        protected TransferProto.UpdateTransferJobRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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

      • getDefaultInstanceForType

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