Class MoveObjectRequest (2.47.0)

public final class MoveObjectRequest extends GeneratedMessageV3 implements MoveObjectRequestOrBuilder

Request message for MoveObject.

Protobuf type google.storage.v2.MoveObjectRequest

Static Fields

BUCKET_FIELD_NUMBER

public static final int BUCKET_FIELD_NUMBER
Field Value
Type Description
int

DESTINATION_OBJECT_FIELD_NUMBER

public static final int DESTINATION_OBJECT_FIELD_NUMBER
Field Value
Type Description
int

IF_GENERATION_MATCH_FIELD_NUMBER

public static final int IF_GENERATION_MATCH_FIELD_NUMBER
Field Value
Type Description
int

IF_GENERATION_NOT_MATCH_FIELD_NUMBER

public static final int IF_GENERATION_NOT_MATCH_FIELD_NUMBER
Field Value
Type Description
int

IF_METAGENERATION_MATCH_FIELD_NUMBER

public static final int IF_METAGENERATION_MATCH_FIELD_NUMBER
Field Value
Type Description
int

IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER

public static final int IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER
Field Value
Type Description
int

IF_SOURCE_GENERATION_MATCH_FIELD_NUMBER

public static final int IF_SOURCE_GENERATION_MATCH_FIELD_NUMBER
Field Value
Type Description
int

IF_SOURCE_GENERATION_NOT_MATCH_FIELD_NUMBER

public static final int IF_SOURCE_GENERATION_NOT_MATCH_FIELD_NUMBER
Field Value
Type Description
int

IF_SOURCE_METAGENERATION_MATCH_FIELD_NUMBER

public static final int IF_SOURCE_METAGENERATION_MATCH_FIELD_NUMBER
Field Value
Type Description
int

IF_SOURCE_METAGENERATION_NOT_MATCH_FIELD_NUMBER

public static final int IF_SOURCE_METAGENERATION_NOT_MATCH_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_OBJECT_FIELD_NUMBER

public static final int SOURCE_OBJECT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MoveObjectRequest getDefaultInstance()
Returns
Type Description
MoveObjectRequest

getDescriptor()

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

newBuilder()

public static MoveObjectRequest.Builder newBuilder()
Returns
Type Description
MoveObjectRequest.Builder

newBuilder(MoveObjectRequest prototype)

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

parseDelimitedFrom(InputStream input)

public static MoveObjectRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MoveObjectRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static MoveObjectRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
MoveObjectRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static MoveObjectRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
MoveObjectRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static MoveObjectRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MoveObjectRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static MoveObjectRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
MoveObjectRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<MoveObjectRequest> parser()
Returns
Type Description
Parser<MoveObjectRequest>

Methods

equals(Object obj)

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

getBucket()

public String getBucket()

Required. Name of the bucket in which the object resides.

string bucket = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The bucket.

getBucketBytes()

public ByteString getBucketBytes()

Required. Name of the bucket in which the object resides.

string bucket = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for bucket.

getDefaultInstanceForType()

public MoveObjectRequest getDefaultInstanceForType()
Returns
Type Description
MoveObjectRequest

getDestinationObject()

public String getDestinationObject()

Required. Name of the destination object.

string destination_object = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The destinationObject.

getDestinationObjectBytes()

public ByteString getDestinationObjectBytes()

Required. Name of the destination object.

string destination_object = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for destinationObject.

getIfGenerationMatch()

public long getIfGenerationMatch()

Optional. Makes the operation conditional on whether the destination object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object. if_generation_match and if_generation_not_match conditions are mutually exclusive: it's an error for both of them to be set in the request.

optional int64 if_generation_match = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The ifGenerationMatch.

getIfGenerationNotMatch()

public long getIfGenerationNotMatch()

Optional. Makes the operation conditional on whether the destination object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object. if_generation_match and if_generation_not_match conditions are mutually exclusive: it's an error for both of them to be set in the request.

optional int64 if_generation_not_match = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The ifGenerationNotMatch.

getIfMetagenerationMatch()

public long getIfMetagenerationMatch()

Optional. Makes the operation conditional on whether the destination object's current metageneration matches the given value. if_metageneration_match and if_metageneration_not_match conditions are mutually exclusive: it's an error for both of them to be set in the request.

optional int64 if_metageneration_match = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The ifMetagenerationMatch.

getIfMetagenerationNotMatch()

public long getIfMetagenerationNotMatch()

Optional. Makes the operation conditional on whether the destination object's current metageneration does not match the given value. if_metageneration_match and if_metageneration_not_match conditions are mutually exclusive: it's an error for both of them to be set in the request.

optional int64 if_metageneration_not_match = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The ifMetagenerationNotMatch.

getIfSourceGenerationMatch()

public long getIfSourceGenerationMatch()

Optional. Makes the operation conditional on whether the source object's current generation matches the given value. if_source_generation_match and if_source_generation_not_match conditions are mutually exclusive: it's an error for both of them to be set in the request.

optional int64 if_source_generation_match = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The ifSourceGenerationMatch.

getIfSourceGenerationNotMatch()

public long getIfSourceGenerationNotMatch()

Optional. Makes the operation conditional on whether the source object's current generation does not match the given value. if_source_generation_match and if_source_generation_not_match conditions are mutually exclusive: it's an error for both of them to be set in the request.

optional int64 if_source_generation_not_match = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The ifSourceGenerationNotMatch.

getIfSourceMetagenerationMatch()

public long getIfSourceMetagenerationMatch()

Optional. Makes the operation conditional on whether the source object's current metageneration matches the given value. if_source_metageneration_match and if_source_metageneration_not_match conditions are mutually exclusive: it's an error for both of them to be set in the request.

optional int64 if_source_metageneration_match = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The ifSourceMetagenerationMatch.

getIfSourceMetagenerationNotMatch()

public long getIfSourceMetagenerationNotMatch()

Optional. Makes the operation conditional on whether the source object's current metageneration does not match the given value. if_source_metageneration_match and if_source_metageneration_not_match conditions are mutually exclusive: it's an error for both of them to be set in the request.

optional int64 if_source_metageneration_not_match = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The ifSourceMetagenerationNotMatch.

getParserForType()

public Parser<MoveObjectRequest> getParserForType()
Returns
Type Description
Parser<MoveObjectRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSourceObject()

public String getSourceObject()

Required. Name of the source object.

string source_object = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The sourceObject.

getSourceObjectBytes()

public ByteString getSourceObjectBytes()

Required. Name of the source object.

string source_object = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for sourceObject.

hasIfGenerationMatch()

public boolean hasIfGenerationMatch()

Optional. Makes the operation conditional on whether the destination object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object. if_generation_match and if_generation_not_match conditions are mutually exclusive: it's an error for both of them to be set in the request.

optional int64 if_generation_match = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the ifGenerationMatch field is set.

hasIfGenerationNotMatch()

public boolean hasIfGenerationNotMatch()

Optional. Makes the operation conditional on whether the destination object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object. if_generation_match and if_generation_not_match conditions are mutually exclusive: it's an error for both of them to be set in the request.

optional int64 if_generation_not_match = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the ifGenerationNotMatch field is set.

hasIfMetagenerationMatch()

public boolean hasIfMetagenerationMatch()

Optional. Makes the operation conditional on whether the destination object's current metageneration matches the given value. if_metageneration_match and if_metageneration_not_match conditions are mutually exclusive: it's an error for both of them to be set in the request.

optional int64 if_metageneration_match = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the ifMetagenerationMatch field is set.

hasIfMetagenerationNotMatch()

public boolean hasIfMetagenerationNotMatch()

Optional. Makes the operation conditional on whether the destination object's current metageneration does not match the given value. if_metageneration_match and if_metageneration_not_match conditions are mutually exclusive: it's an error for both of them to be set in the request.

optional int64 if_metageneration_not_match = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the ifMetagenerationNotMatch field is set.

hasIfSourceGenerationMatch()

public boolean hasIfSourceGenerationMatch()

Optional. Makes the operation conditional on whether the source object's current generation matches the given value. if_source_generation_match and if_source_generation_not_match conditions are mutually exclusive: it's an error for both of them to be set in the request.

optional int64 if_source_generation_match = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the ifSourceGenerationMatch field is set.

hasIfSourceGenerationNotMatch()

public boolean hasIfSourceGenerationNotMatch()

Optional. Makes the operation conditional on whether the source object's current generation does not match the given value. if_source_generation_match and if_source_generation_not_match conditions are mutually exclusive: it's an error for both of them to be set in the request.

optional int64 if_source_generation_not_match = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the ifSourceGenerationNotMatch field is set.

hasIfSourceMetagenerationMatch()

public boolean hasIfSourceMetagenerationMatch()

Optional. Makes the operation conditional on whether the source object's current metageneration matches the given value. if_source_metageneration_match and if_source_metageneration_not_match conditions are mutually exclusive: it's an error for both of them to be set in the request.

optional int64 if_source_metageneration_match = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the ifSourceMetagenerationMatch field is set.

hasIfSourceMetagenerationNotMatch()

public boolean hasIfSourceMetagenerationNotMatch()

Optional. Makes the operation conditional on whether the source object's current metageneration does not match the given value. if_source_metageneration_match and if_source_metageneration_not_match conditions are mutually exclusive: it's an error for both of them to be set in the request.

optional int64 if_source_metageneration_not_match = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the ifSourceMetagenerationNotMatch 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 MoveObjectRequest.Builder newBuilderForType()
Returns
Type Description
MoveObjectRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public MoveObjectRequest.Builder toBuilder()
Returns
Type Description
MoveObjectRequest.Builder

writeTo(CodedOutputStream output)

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