Class GetObjectRequest (2.7.1)

public final class GetObjectRequest extends GeneratedMessageV3 implements GetObjectRequestOrBuilder

Request message for GetObject.

Protobuf type google.storage.v2.GetObjectRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > GetObjectRequest

Implements

GetObjectRequestOrBuilder

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

BUCKET_FIELD_NUMBER

public static final int BUCKET_FIELD_NUMBER

Field Value

Type	Description
int

COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER

public static final int COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER

Field Value

Type	Description
int

GENERATION_FIELD_NUMBER

public static final int GENERATION_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

OBJECT_FIELD_NUMBER

public static final int OBJECT_FIELD_NUMBER

Field Value

Type	Description
int

READ_MASK_FIELD_NUMBER

public static final int READ_MASK_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static GetObjectRequest getDefaultInstance()

Returns

Type	Description
GetObjectRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static GetObjectRequest.Builder newBuilder()

Returns

Type	Description
GetObjectRequest.Builder

newBuilder(GetObjectRequest prototype)

public static GetObjectRequest.Builder newBuilder(GetObjectRequest prototype)

Parameter

Name	Description
prototype	`GetObjectRequest`

Returns

Type	Description
GetObjectRequest.Builder

parseDelimitedFrom(InputStream input)

public static GetObjectRequest parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	`InputStream`

Returns

Type	Description
GetObjectRequest

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GetObjectRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`InputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
GetObjectRequest

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static GetObjectRequest parseFrom(byte[] data)

Parameter

Name	Description
data	`byte[]`

Returns

Type	Description
GetObjectRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GetObjectRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	`byte[]`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
GetObjectRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GetObjectRequest parseFrom(ByteString data)

Parameter

Name	Description
data	`ByteString`

Returns

Type	Description
GetObjectRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GetObjectRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	`ByteString`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
GetObjectRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GetObjectRequest parseFrom(CodedInputStream input)

Parameter

Name	Description
input	`CodedInputStream`

Returns

Type	Description
GetObjectRequest

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GetObjectRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
GetObjectRequest

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static GetObjectRequest parseFrom(InputStream input)

Parameter

Name	Description
input	`InputStream`

Returns

Type	Description
GetObjectRequest

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GetObjectRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`InputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
GetObjectRequest

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static GetObjectRequest parseFrom(ByteBuffer data)

Parameter

Name	Description
data	`ByteBuffer`

Returns

Type	Description
GetObjectRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GetObjectRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	`ByteBuffer`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
GetObjectRequest

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<GetObjectRequest> parser()

Returns

Type	Description
Parser<GetObjectRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	`Object`

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getBucket()

public String getBucket()

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

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

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

Returns

Type	Description
ByteString	The bytes for bucket.

getCommonObjectRequestParams()

public CommonObjectRequestParams getCommonObjectRequestParams()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

Returns

Type	Description
CommonObjectRequestParams	The commonObjectRequestParams.

getCommonObjectRequestParamsOrBuilder()

public CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

Returns

Type	Description
CommonObjectRequestParamsOrBuilder

getDefaultInstanceForType()

public GetObjectRequest getDefaultInstanceForType()

Returns

Type	Description
GetObjectRequest

getGeneration()

public long getGeneration()

If present, selects a specific revision of this object (as opposed to the latest version, the default).

int64 generation = 3;

Returns

Type	Description
long	The generation.

getIfGenerationMatch()

public long getIfGenerationMatch()

Makes the operation conditional on whether the 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.

optional int64 if_generation_match = 4;

Returns

Type	Description
long	The ifGenerationMatch.

getIfGenerationNotMatch()

public long getIfGenerationNotMatch()

Makes the operation conditional on whether the 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.

optional int64 if_generation_not_match = 5;

Returns

Type	Description
long	The ifGenerationNotMatch.

getIfMetagenerationMatch()

public long getIfMetagenerationMatch()

Makes the operation conditional on whether the object's current metageneration matches the given value.

optional int64 if_metageneration_match = 6;

Returns

Type	Description
long	The ifMetagenerationMatch.

getIfMetagenerationNotMatch()

public long getIfMetagenerationNotMatch()

Makes the operation conditional on whether the object's current metageneration does not match the given value.

optional int64 if_metageneration_not_match = 7;

Returns

Type	Description
long	The ifMetagenerationNotMatch.

getObject()

public String getObject()

Required. Name of the object.

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

Returns

Type	Description
String	The object.

getObjectBytes()

public ByteString getObjectBytes()

Required. Name of the object.

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

Returns

Type	Description
ByteString	The bytes for object.

getParserForType()

public Parser<GetObjectRequest> getParserForType()

Returns

Type	Description
Parser<GetObjectRequest>

Overrides

GeneratedMessageV3.getParserForType()

getReadMask()

public FieldMask getReadMask()

Mask specifying which fields to read. If no mask is specified, will default to all fields except metadata.acl and metadata.owner.

may be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 10;

Returns

Type	Description
FieldMask	The readMask.

getReadMaskOrBuilder()

public FieldMaskOrBuilder getReadMaskOrBuilder()

Mask specifying which fields to read. If no mask is specified, will default to all fields except metadata.acl and metadata.owner.

may be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 10;

Returns

Type	Description
FieldMaskOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

hasCommonObjectRequestParams()

public boolean hasCommonObjectRequestParams()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

Returns

Type	Description
boolean	Whether the commonObjectRequestParams field is set.

hasIfGenerationMatch()

public boolean hasIfGenerationMatch()

Makes the operation conditional on whether the 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.

optional int64 if_generation_match = 4;

Returns

Type	Description
boolean	Whether the ifGenerationMatch field is set.

hasIfGenerationNotMatch()

public boolean hasIfGenerationNotMatch()

optional int64 if_generation_not_match = 5;

Returns

Type	Description
boolean	Whether the ifGenerationNotMatch field is set.

hasIfMetagenerationMatch()

public boolean hasIfMetagenerationMatch()

Makes the operation conditional on whether the object's current metageneration matches the given value.

optional int64 if_metageneration_match = 6;

Returns

Type	Description
boolean	Whether the ifMetagenerationMatch field is set.

hasIfMetagenerationNotMatch()

public boolean hasIfMetagenerationNotMatch()

Makes the operation conditional on whether the object's current metageneration does not match the given value.

optional int64 if_metageneration_not_match = 7;

Returns

Type	Description
boolean	Whether the ifMetagenerationNotMatch field is set.

hasReadMask()

public boolean hasReadMask()

Mask specifying which fields to read. If no mask is specified, will default to all fields except metadata.acl and metadata.owner.

may be used to mean "all fields".

optional .google.protobuf.FieldMask read_mask = 10;

Returns

Type	Description
boolean	Whether the readMask 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 GetObjectRequest.Builder newBuilderForType()

Returns

Type	Description
GetObjectRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GetObjectRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	`BuilderParent`

Returns

Type	Description
GetObjectRequest.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 GetObjectRequest.Builder toBuilder()

Returns

Type	Description
GetObjectRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException