Class TransferProto.UpdateTransferJobRequest (1.20.0)

public static final class TransferProto.UpdateTransferJobRequest extends GeneratedMessageV3 implements TransferProto.UpdateTransferJobRequestOrBuilder

Request passed to UpdateTransferJob.

Protobuf type google.storagetransfer.v1.UpdateTransferJobRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TransferProto.UpdateTransferJobRequest

Static Fields

JOB_NAME_FIELD_NUMBER

public static final int JOB_NAME_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

TRANSFER_JOB_FIELD_NUMBER

public static final int TRANSFER_JOB_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TRANSFER_JOB_FIELD_MASK_FIELD_NUMBER

public static final int UPDATE_TRANSFER_JOB_FIELD_MASK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TransferProto.UpdateTransferJobRequest getDefaultInstance()
Returns
Type Description
TransferProto.UpdateTransferJobRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TransferProto.UpdateTransferJobRequest.Builder newBuilder()
Returns
Type Description
TransferProto.UpdateTransferJobRequest.Builder

newBuilder(TransferProto.UpdateTransferJobRequest prototype)

public static TransferProto.UpdateTransferJobRequest.Builder newBuilder(TransferProto.UpdateTransferJobRequest prototype)
Parameter
Name Description
prototype TransferProto.UpdateTransferJobRequest
Returns
Type Description
TransferProto.UpdateTransferJobRequest.Builder

parseDelimitedFrom(InputStream input)

public static TransferProto.UpdateTransferJobRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TransferProto.UpdateTransferJobRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferProto.UpdateTransferJobRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferProto.UpdateTransferJobRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TransferProto.UpdateTransferJobRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TransferProto.UpdateTransferJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransferProto.UpdateTransferJobRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferProto.UpdateTransferJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TransferProto.UpdateTransferJobRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TransferProto.UpdateTransferJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransferProto.UpdateTransferJobRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferProto.UpdateTransferJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TransferProto.UpdateTransferJobRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TransferProto.UpdateTransferJobRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferProto.UpdateTransferJobRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferProto.UpdateTransferJobRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TransferProto.UpdateTransferJobRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TransferProto.UpdateTransferJobRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferProto.UpdateTransferJobRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferProto.UpdateTransferJobRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TransferProto.UpdateTransferJobRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TransferProto.UpdateTransferJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransferProto.UpdateTransferJobRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferProto.UpdateTransferJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TransferProto.UpdateTransferJobRequest> parser()
Returns
Type Description
Parser<UpdateTransferJobRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public TransferProto.UpdateTransferJobRequest getDefaultInstanceForType()
Returns
Type Description
TransferProto.UpdateTransferJobRequest

getJobName()

public String getJobName()

Required. The name of job to update.

string job_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
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];

Returns
Type Description
ByteString

The bytes for jobName.

getParserForType()

public Parser<TransferProto.UpdateTransferJobRequest> getParserForType()
Returns
Type Description
Parser<UpdateTransferJobRequest>
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];

Returns
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];

Returns
Type Description
ByteString

The bytes for projectId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
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];

Returns
Type Description
TransferTypes.TransferJob

The transferJob.

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];

Returns
Type Description
TransferTypes.TransferJobOrBuilder

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;

Returns
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;

Returns
Type Description
FieldMaskOrBuilder

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];

Returns
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;

Returns
Type Description
boolean

Whether the updateTransferJobFieldMask field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TransferProto.UpdateTransferJobRequest.Builder newBuilderForType()
Returns
Type Description
TransferProto.UpdateTransferJobRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransferProto.UpdateTransferJobRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TransferProto.UpdateTransferJobRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TransferProto.UpdateTransferJobRequest.Builder toBuilder()
Returns
Type Description
TransferProto.UpdateTransferJobRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException