Send feedback Class GetObjectRequest (2.20.2) Stay organized with collections Save and categorize content based on your preferences.
Version 2.20.2keyboard_arrow_down
public final class GetObjectRequest extends GeneratedMessageV3 implements GetObjectRequestOrBuilder Request message for GetObject.
Protobuf type google.storage.v2.GetObjectRequest
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
public static final int IF_METAGENERATION_MATCH_FIELD_NUMBER Field Value Type Description int
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 () getDescriptor()
public static final Descriptors . Descriptor getDescriptor () newBuilder()
public static GetObjectRequest . Builder newBuilder () newBuilder(GetObjectRequest )
public static GetObjectRequest . Builder newBuilder ( GetObjectRequest )
public static GetObjectRequest parseDelimitedFrom ( InputStream input )
public static GetObjectRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry ) parseFrom(byte[] data)
public static GetObjectRequest parseFrom ( byte [] data ) Parameter Name Description databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GetObjectRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry ) parseFrom(ByteString data)
public static GetObjectRequest parseFrom ( ByteString data ) parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GetObjectRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static GetObjectRequest parseFrom ( CodedInputStream input )
public static GetObjectRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static GetObjectRequest parseFrom ( InputStream input )
public static GetObjectRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry ) parseFrom(ByteBuffer data)
public static GetObjectRequest parseFrom ( ByteBuffer data ) parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GetObjectRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry ) parser()
public static Parser<GetObjectRequest> parser () Methods equals(Object obj)
public boolean equals ( Object obj ) Parameter Name Description objObject
Overrides 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;
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;
getDefaultInstanceForType()
public GetObjectRequest getDefaultInstanceForType () 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 live 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.
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.
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 () Overrides 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;
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;
getSerializedSize()
public int getSerializedSize () Returns Type Description int
Overrides getUnknownFields()
public final UnknownFieldSet getUnknownFields () Overrides 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 () Makes the operation conditional on whether the object's live 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 boolean Whether the ifGenerationNotMatch field is set.
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.
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() Returns Type Description int
Overrides internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable () Overrides isInitialized()
public final boolean isInitialized () Overrides newBuilderForType()
public GetObjectRequest . Builder newBuilderForType () newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected GetObjectRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent ) Overrides newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused ) Overrides toBuilder()
public GetObjectRequest . Builder toBuilder () writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output ) Overrides Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-12 UTC.
Need to tell us more? [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-12 UTC."],[],[]]