Class TransferProto.UpdateTransferJobRequest (1.0.4)

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

Implements

TransferProto.UpdateTransferJobRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

AbstractMessage.equals(Object other)

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

GeneratedMessageV3.getParserForType()

getProjectId()

public String getProjectId()

Required. The ID of the Google Cloud Platform Console 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 Platform Console 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

GeneratedMessageV3.getSerializedSize()

getTransferJob()

public TransferTypes.TransferJob getTransferJob()

Required. The job to update. transferJob is expected to specify only four fields: description, transfer_spec, notification_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 permissions.

.google.storagetransfer.v1.TransferJob transfer_job = 3 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
TransferTypes.TransferJob	The transferJob.

getTransferJobOrBuilder()

public TransferTypes.TransferJobOrBuilder getTransferJobOrBuilder()

.google.storagetransfer.v1.TransferJob transfer_job = 3 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
TransferTypes.TransferJobOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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, 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()

.google.protobuf.FieldMask update_transfer_job_field_mask = 4;

Returns

Type	Description
FieldMaskOrBuilder

hasTransferJob()

public boolean hasTransferJob()

.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()

.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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	`UnusedPrivateParameter`

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException