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
COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
public static final int COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
Field Value
GENERATION_FIELD_NUMBER
public static final int GENERATION_FIELD_NUMBER
Field Value
IF_GENERATION_MATCH_FIELD_NUMBER
public static final int IF_GENERATION_MATCH_FIELD_NUMBER
Field Value
IF_GENERATION_NOT_MATCH_FIELD_NUMBER
public static final int IF_GENERATION_NOT_MATCH_FIELD_NUMBER
Field Value
public static final int IF_METAGENERATION_MATCH_FIELD_NUMBER
Field Value
public static final int IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER
Field Value
OBJECT_FIELD_NUMBER
public static final int OBJECT_FIELD_NUMBER
Field Value
READ_MASK_FIELD_NUMBER
public static final int READ_MASK_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static GetObjectRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static GetObjectRequest.Builder newBuilder()
Returns
newBuilder(GetObjectRequest prototype)
public static GetObjectRequest.Builder newBuilder(GetObjectRequest prototype)
Parameter
Returns
public static GetObjectRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static GetObjectRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static GetObjectRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GetObjectRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static GetObjectRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GetObjectRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static GetObjectRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static GetObjectRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static GetObjectRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static GetObjectRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static GetObjectRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GetObjectRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<GetObjectRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getBucket()
public String getBucket()
Required. Name of the bucket in which the object resides.
string bucket = 1 [(.google.api.field_behavior) = REQUIRED];
| 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];
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()
Returns
getGeneration()
public long getGeneration()
If present, selects a specific revision of this object (as opposed to the
latest version, the default).
int64 generation = 3;
| 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;
| 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;
| 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;
| 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;
| Type | Description |
| long | The ifMetagenerationNotMatch.
|
getObject()
public String getObject()
Required. Name of the object.
string object = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The object.
|
getObjectBytes()
public ByteString getObjectBytes()
Required. Name of the object.
string object = 2 [(.google.api.field_behavior) = REQUIRED];
getParserForType()
public Parser<GetObjectRequest> getParserForType()
Returns
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
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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;
| 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;
| 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;
| 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;
| 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;
| 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;
| Type | Description |
| boolean | Whether the readMask field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public GetObjectRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected GetObjectRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public GetObjectRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
