public static final class GetObjectRequest.Builder extends GeneratedMessageV3.Builder<GetObjectRequest.Builder> implements GetObjectRequestOrBuilderRequest message for GetObject.
Protobuf type google.storage.v2.GetObjectRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GetObjectRequest.BuilderImplements
GetObjectRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public GetObjectRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
|
build()
public GetObjectRequest build()| Returns | |
|---|---|
| Type | Description |
GetObjectRequest |
|
buildPartial()
public GetObjectRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
GetObjectRequest |
|
clear()
public GetObjectRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
|
clearBucket()
public GetObjectRequest.Builder clearBucket()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 |
GetObjectRequest.Builder |
This builder for chaining. |
clearCommonObjectRequestParams()
public GetObjectRequest.Builder clearCommonObjectRequestParams()A set of parameters common to Storage API requests concerning an object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public GetObjectRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
|
clearGeneration()
public GetObjectRequest.Builder clearGeneration()If present, selects a specific revision of this object (as opposed to the latest version, the default).
int64 generation = 3;
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
This builder for chaining. |
clearIfGenerationMatch()
public GetObjectRequest.Builder clearIfGenerationMatch()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 |
GetObjectRequest.Builder |
This builder for chaining. |
clearIfGenerationNotMatch()
public GetObjectRequest.Builder clearIfGenerationNotMatch()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 |
GetObjectRequest.Builder |
This builder for chaining. |
clearIfMetagenerationMatch()
public GetObjectRequest.Builder clearIfMetagenerationMatch()Makes the operation conditional on whether the object's current metageneration matches the given value.
optional int64 if_metageneration_match = 6;
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
This builder for chaining. |
clearIfMetagenerationNotMatch()
public GetObjectRequest.Builder clearIfMetagenerationNotMatch()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 |
GetObjectRequest.Builder |
This builder for chaining. |
clearObject()
public GetObjectRequest.Builder clearObject()Required. Name of the object.
string object = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public GetObjectRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
|
clearReadMask()
public GetObjectRequest.Builder clearReadMask()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 |
GetObjectRequest.Builder |
|
clone()
public GetObjectRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
|
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. |
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. |
getCommonObjectRequestParamsBuilder()
public CommonObjectRequestParams.Builder getCommonObjectRequestParamsBuilder()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.Builder |
|
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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
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. |
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. |
getReadMaskBuilder()
public FieldMask.Builder getReadMaskBuilder()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 |
Builder |
|
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 |
|
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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeCommonObjectRequestParams(CommonObjectRequestParams value)
public GetObjectRequest.Builder mergeCommonObjectRequestParams(CommonObjectRequestParams value)A set of parameters common to Storage API requests concerning an object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
CommonObjectRequestParams |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public GetObjectRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public GetObjectRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
|
mergeFrom(GetObjectRequest other)
public GetObjectRequest.Builder mergeFrom(GetObjectRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
GetObjectRequest |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
|
mergeReadMask(FieldMask value)
public GetObjectRequest.Builder mergeReadMask(FieldMask value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
FieldMask |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final GetObjectRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
|
setBucket(String value)
public GetObjectRequest.Builder setBucket(String value)Required. Name of the bucket in which the object resides.
string bucket = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe bucket to set. |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
This builder for chaining. |
setBucketBytes(ByteString value)
public GetObjectRequest.Builder setBucketBytes(ByteString value)Required. Name of the bucket in which the object resides.
string bucket = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for bucket to set. |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
This builder for chaining. |
setCommonObjectRequestParams(CommonObjectRequestParams value)
public GetObjectRequest.Builder setCommonObjectRequestParams(CommonObjectRequestParams value)A set of parameters common to Storage API requests concerning an object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
CommonObjectRequestParams |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
|
setCommonObjectRequestParams(CommonObjectRequestParams.Builder builderForValue)
public GetObjectRequest.Builder setCommonObjectRequestParams(CommonObjectRequestParams.Builder builderForValue)A set of parameters common to Storage API requests concerning an object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CommonObjectRequestParams.Builder |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public GetObjectRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
|
setGeneration(long value)
public GetObjectRequest.Builder setGeneration(long value)If present, selects a specific revision of this object (as opposed to the latest version, the default).
int64 generation = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe generation to set. |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
This builder for chaining. |
setIfGenerationMatch(long value)
public GetObjectRequest.Builder setIfGenerationMatch(long value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe ifGenerationMatch to set. |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
This builder for chaining. |
setIfGenerationNotMatch(long value)
public GetObjectRequest.Builder setIfGenerationNotMatch(long value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe ifGenerationNotMatch to set. |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
This builder for chaining. |
setIfMetagenerationMatch(long value)
public GetObjectRequest.Builder setIfMetagenerationMatch(long value)Makes the operation conditional on whether the object's current metageneration matches the given value.
optional int64 if_metageneration_match = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe ifMetagenerationMatch to set. |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
This builder for chaining. |
setIfMetagenerationNotMatch(long value)
public GetObjectRequest.Builder setIfMetagenerationNotMatch(long value)Makes the operation conditional on whether the object's current metageneration does not match the given value.
optional int64 if_metageneration_not_match = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe ifMetagenerationNotMatch to set. |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
This builder for chaining. |
setObject(String value)
public GetObjectRequest.Builder setObject(String value)Required. Name of the object.
string object = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe object to set. |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
This builder for chaining. |
setObjectBytes(ByteString value)
public GetObjectRequest.Builder setObjectBytes(ByteString value)Required. Name of the object.
string object = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for object to set. |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
This builder for chaining. |
setReadMask(FieldMask value)
public GetObjectRequest.Builder setReadMask(FieldMask value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
FieldMask |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
|
setReadMask(FieldMask.Builder builderForValue)
public GetObjectRequest.Builder setReadMask(FieldMask.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public GetObjectRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final GetObjectRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
GetObjectRequest.Builder |
|