public static final class TransferProto.UpdateTransferJobRequest extends GeneratedMessageV3 implements TransferProto.UpdateTransferJobRequestOrBuilder
Request passed to UpdateTransferJob.
Protobuf type google.storagetransfer.v1.UpdateTransferJobRequest
Static Fields
JOB_NAME_FIELD_NUMBER
public static final int JOB_NAME_FIELD_NUMBER
Field Value
PROJECT_ID_FIELD_NUMBER
public static final int PROJECT_ID_FIELD_NUMBER
Field Value
TRANSFER_JOB_FIELD_NUMBER
public static final int TRANSFER_JOB_FIELD_NUMBER
Field Value
UPDATE_TRANSFER_JOB_FIELD_MASK_FIELD_NUMBER
public static final int UPDATE_TRANSFER_JOB_FIELD_MASK_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static TransferProto.UpdateTransferJobRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static TransferProto.UpdateTransferJobRequest.Builder newBuilder()
Returns
newBuilder(TransferProto.UpdateTransferJobRequest prototype)
public static TransferProto.UpdateTransferJobRequest.Builder newBuilder(TransferProto.UpdateTransferJobRequest prototype)
Parameter
Returns
public static TransferProto.UpdateTransferJobRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static TransferProto.UpdateTransferJobRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static TransferProto.UpdateTransferJobRequest parseFrom(byte[] data)
Parameter
| Name |
Description |
| data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TransferProto.UpdateTransferJobRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static TransferProto.UpdateTransferJobRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TransferProto.UpdateTransferJobRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TransferProto.UpdateTransferJobRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static TransferProto.UpdateTransferJobRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TransferProto.UpdateTransferJobRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static TransferProto.UpdateTransferJobRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static TransferProto.UpdateTransferJobRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TransferProto.UpdateTransferJobRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<TransferProto.UpdateTransferJobRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public TransferProto.UpdateTransferJobRequest getDefaultInstanceForType()
Returns
getJobName()
public String getJobName()
Required. The name of job to update.
string job_name = 1 [(.google.api.field_behavior) = REQUIRED];
| Type |
Description |
| String |
The jobName.
|
getJobNameBytes()
public ByteString getJobNameBytes()
Required. The name of job to update.
string job_name = 1 [(.google.api.field_behavior) = REQUIRED];
| Type |
Description |
| ByteString |
The bytes for jobName.
|
getParserForType()
public Parser<TransferProto.UpdateTransferJobRequest> getParserForType()
Returns
Overrides
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];
| Type |
Description |
| String |
The projectId.
|
getProjectIdBytes()
public ByteString getProjectIdBytes()
Required. The ID of the Google Cloud project that owns the
job.
string project_id = 2 [(.google.api.field_behavior) = REQUIRED];
| Type |
Description |
| ByteString |
The bytes for projectId.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getTransferJob()
public TransferTypes.TransferJob getTransferJob()
Required. The job to update. transferJob is expected to specify one or more of
five fields: description,
transfer_spec,
notification_config,
logging_config, and
status. An UpdateTransferJobRequest that specifies
other fields are rejected with the error
INVALID_ARGUMENT. Updating a job status
to DELETED requires
storagetransfer.jobs.delete permission.
.google.storagetransfer.v1.TransferJob transfer_job = 3 [(.google.api.field_behavior) = REQUIRED];
getTransferJobOrBuilder()
public TransferTypes.TransferJobOrBuilder getTransferJobOrBuilder()
Required. The job to update. transferJob is expected to specify one or more of
five fields: description,
transfer_spec,
notification_config,
logging_config, and
status. An UpdateTransferJobRequest that specifies
other fields are rejected with the error
INVALID_ARGUMENT. Updating a job status
to DELETED requires
storagetransfer.jobs.delete permission.
.google.storagetransfer.v1.TransferJob transfer_job = 3 [(.google.api.field_behavior) = REQUIRED];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUpdateTransferJobFieldMask()
public 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,
transfer_spec,
notification_config,
logging_config, and
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.protobuf.FieldMask update_transfer_job_field_mask = 4;
| Type |
Description |
| FieldMask |
The updateTransferJobFieldMask.
|
getUpdateTransferJobFieldMaskOrBuilder()
public 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,
transfer_spec,
notification_config,
logging_config, and
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.protobuf.FieldMask update_transfer_job_field_mask = 4;
hasTransferJob()
public boolean hasTransferJob()
Required. The job to update. transferJob is expected to specify one or more of
five fields: description,
transfer_spec,
notification_config,
logging_config, and
status. An UpdateTransferJobRequest that specifies
other fields are rejected with the error
INVALID_ARGUMENT. Updating a job status
to DELETED requires
storagetransfer.jobs.delete permission.
.google.storagetransfer.v1.TransferJob transfer_job = 3 [(.google.api.field_behavior) = REQUIRED];
| Type |
Description |
| boolean |
Whether the transferJob field is set.
|
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,
transfer_spec,
notification_config,
logging_config, and
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.protobuf.FieldMask update_transfer_job_field_mask = 4;
| Type |
Description |
| boolean |
Whether the updateTransferJobFieldMask field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public TransferProto.UpdateTransferJobRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TransferProto.UpdateTransferJobRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public TransferProto.UpdateTransferJobRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
