public static final class GetObjectRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<GetObjectRequest.Builder> implements GetObjectRequestOrBuilder
Request message for GetObject.Protobuf type
google.storage.v2.GetObjectRequest
Modifier and Type | Method and Description |
---|---|
GetObjectRequest.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
GetObjectRequest |
build() |
GetObjectRequest |
buildPartial() |
GetObjectRequest.Builder |
clear() |
GetObjectRequest.Builder |
clearBucket()
Required.
|
GetObjectRequest.Builder |
clearCommonObjectRequestParams()
A set of parameters common to Storage API requests concerning an object.
|
GetObjectRequest.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
GetObjectRequest.Builder |
clearGeneration()
If present, selects a specific revision of this object (as opposed to the
latest version, the default).
|
GetObjectRequest.Builder |
clearIfGenerationMatch()
Makes the operation conditional on whether the object's current generation
matches the given value.
|
GetObjectRequest.Builder |
clearIfGenerationNotMatch()
Makes the operation conditional on whether the object's live generation
does not match the given value.
|
GetObjectRequest.Builder |
clearIfMetagenerationMatch()
Makes the operation conditional on whether the object's current
metageneration matches the given value.
|
GetObjectRequest.Builder |
clearIfMetagenerationNotMatch()
Makes the operation conditional on whether the object's current
metageneration does not match the given value.
|
GetObjectRequest.Builder |
clearObject()
Required.
|
GetObjectRequest.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
GetObjectRequest.Builder |
clearReadMask()
Mask specifying which fields to read.
|
GetObjectRequest.Builder |
clone() |
String |
getBucket()
Required.
|
com.google.protobuf.ByteString |
getBucketBytes()
Required.
|
CommonObjectRequestParams |
getCommonObjectRequestParams()
A set of parameters common to Storage API requests concerning an object.
|
CommonObjectRequestParams.Builder |
getCommonObjectRequestParamsBuilder()
A set of parameters common to Storage API requests concerning an object.
|
CommonObjectRequestParamsOrBuilder |
getCommonObjectRequestParamsOrBuilder()
A set of parameters common to Storage API requests concerning an object.
|
GetObjectRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
long |
getGeneration()
If present, selects a specific revision of this object (as opposed to the
latest version, the default).
|
long |
getIfGenerationMatch()
Makes the operation conditional on whether the object's current generation
matches the given value.
|
long |
getIfGenerationNotMatch()
Makes the operation conditional on whether the object's live generation
does not match the given value.
|
long |
getIfMetagenerationMatch()
Makes the operation conditional on whether the object's current
metageneration matches the given value.
|
long |
getIfMetagenerationNotMatch()
Makes the operation conditional on whether the object's current
metageneration does not match the given value.
|
String |
getObject()
Required.
|
com.google.protobuf.ByteString |
getObjectBytes()
Required.
|
com.google.protobuf.FieldMask |
getReadMask()
Mask specifying which fields to read.
|
com.google.protobuf.FieldMask.Builder |
getReadMaskBuilder()
Mask specifying which fields to read.
|
com.google.protobuf.FieldMaskOrBuilder |
getReadMaskOrBuilder()
Mask specifying which fields to read.
|
boolean |
hasCommonObjectRequestParams()
A set of parameters common to Storage API requests concerning an object.
|
boolean |
hasIfGenerationMatch()
Makes the operation conditional on whether the object's current generation
matches the given value.
|
boolean |
hasIfGenerationNotMatch()
Makes the operation conditional on whether the object's live generation
does not match the given value.
|
boolean |
hasIfMetagenerationMatch()
Makes the operation conditional on whether the object's current
metageneration matches the given value.
|
boolean |
hasIfMetagenerationNotMatch()
Makes the operation conditional on whether the object's current
metageneration does not match the given value.
|
boolean |
hasReadMask()
Mask specifying which fields to read.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
GetObjectRequest.Builder |
mergeCommonObjectRequestParams(CommonObjectRequestParams value)
A set of parameters common to Storage API requests concerning an object.
|
GetObjectRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
GetObjectRequest.Builder |
mergeFrom(GetObjectRequest other) |
GetObjectRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
GetObjectRequest.Builder |
mergeReadMask(com.google.protobuf.FieldMask value)
Mask specifying which fields to read.
|
GetObjectRequest.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
GetObjectRequest.Builder |
setBucket(String value)
Required.
|
GetObjectRequest.Builder |
setBucketBytes(com.google.protobuf.ByteString value)
Required.
|
GetObjectRequest.Builder |
setCommonObjectRequestParams(CommonObjectRequestParams.Builder builderForValue)
A set of parameters common to Storage API requests concerning an object.
|
GetObjectRequest.Builder |
setCommonObjectRequestParams(CommonObjectRequestParams value)
A set of parameters common to Storage API requests concerning an object.
|
GetObjectRequest.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
GetObjectRequest.Builder |
setGeneration(long value)
If present, selects a specific revision of this object (as opposed to the
latest version, the default).
|
GetObjectRequest.Builder |
setIfGenerationMatch(long value)
Makes the operation conditional on whether the object's current generation
matches the given value.
|
GetObjectRequest.Builder |
setIfGenerationNotMatch(long value)
Makes the operation conditional on whether the object's live generation
does not match the given value.
|
GetObjectRequest.Builder |
setIfMetagenerationMatch(long value)
Makes the operation conditional on whether the object's current
metageneration matches the given value.
|
GetObjectRequest.Builder |
setIfMetagenerationNotMatch(long value)
Makes the operation conditional on whether the object's current
metageneration does not match the given value.
|
GetObjectRequest.Builder |
setObject(String value)
Required.
|
GetObjectRequest.Builder |
setObjectBytes(com.google.protobuf.ByteString value)
Required.
|
GetObjectRequest.Builder |
setReadMask(com.google.protobuf.FieldMask.Builder builderForValue)
Mask specifying which fields to read.
|
GetObjectRequest.Builder |
setReadMask(com.google.protobuf.FieldMask value)
Mask specifying which fields to read.
|
GetObjectRequest.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
GetObjectRequest.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3.Builder<GetObjectRequest.Builder>
public GetObjectRequest.Builder clear()
clear
in interface com.google.protobuf.Message.Builder
clear
in interface com.google.protobuf.MessageLite.Builder
clear
in class com.google.protobuf.GeneratedMessageV3.Builder<GetObjectRequest.Builder>
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType
in interface com.google.protobuf.Message.Builder
getDescriptorForType
in interface com.google.protobuf.MessageOrBuilder
getDescriptorForType
in class com.google.protobuf.GeneratedMessageV3.Builder<GetObjectRequest.Builder>
public GetObjectRequest getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
public GetObjectRequest build()
build
in interface com.google.protobuf.Message.Builder
build
in interface com.google.protobuf.MessageLite.Builder
public GetObjectRequest buildPartial()
buildPartial
in interface com.google.protobuf.Message.Builder
buildPartial
in interface com.google.protobuf.MessageLite.Builder
public GetObjectRequest.Builder clone()
clone
in interface com.google.protobuf.Message.Builder
clone
in interface com.google.protobuf.MessageLite.Builder
clone
in class com.google.protobuf.GeneratedMessageV3.Builder<GetObjectRequest.Builder>
public GetObjectRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField
in interface com.google.protobuf.Message.Builder
setField
in class com.google.protobuf.GeneratedMessageV3.Builder<GetObjectRequest.Builder>
public GetObjectRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField
in interface com.google.protobuf.Message.Builder
clearField
in class com.google.protobuf.GeneratedMessageV3.Builder<GetObjectRequest.Builder>
public GetObjectRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof
in interface com.google.protobuf.Message.Builder
clearOneof
in class com.google.protobuf.GeneratedMessageV3.Builder<GetObjectRequest.Builder>
public GetObjectRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField
in interface com.google.protobuf.Message.Builder
setRepeatedField
in class com.google.protobuf.GeneratedMessageV3.Builder<GetObjectRequest.Builder>
public GetObjectRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField
in interface com.google.protobuf.Message.Builder
addRepeatedField
in class com.google.protobuf.GeneratedMessageV3.Builder<GetObjectRequest.Builder>
public GetObjectRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom
in interface com.google.protobuf.Message.Builder
mergeFrom
in class com.google.protobuf.AbstractMessage.Builder<GetObjectRequest.Builder>
public GetObjectRequest.Builder mergeFrom(GetObjectRequest other)
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3.Builder<GetObjectRequest.Builder>
public GetObjectRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom
in interface com.google.protobuf.Message.Builder
mergeFrom
in interface com.google.protobuf.MessageLite.Builder
mergeFrom
in class com.google.protobuf.AbstractMessage.Builder<GetObjectRequest.Builder>
IOException
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) = { ... }
getBucket
in interface GetObjectRequestOrBuilder
public com.google.protobuf.ByteString getBucketBytes()
Required. Name of the bucket in which the object resides.
string bucket = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getBucketBytes
in interface GetObjectRequestOrBuilder
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) = { ... }
value
- The bucket to set.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) = { ... }
public GetObjectRequest.Builder setBucketBytes(com.google.protobuf.ByteString value)
Required. Name of the bucket in which the object resides.
string bucket = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
value
- The bytes for bucket to set.public String getObject()
Required. Name of the object.
string object = 2 [(.google.api.field_behavior) = REQUIRED];
getObject
in interface GetObjectRequestOrBuilder
public com.google.protobuf.ByteString getObjectBytes()
Required. Name of the object.
string object = 2 [(.google.api.field_behavior) = REQUIRED];
getObjectBytes
in interface GetObjectRequestOrBuilder
public GetObjectRequest.Builder setObject(String value)
Required. Name of the object.
string object = 2 [(.google.api.field_behavior) = REQUIRED];
value
- The object to set.public GetObjectRequest.Builder clearObject()
Required. Name of the object.
string object = 2 [(.google.api.field_behavior) = REQUIRED];
public GetObjectRequest.Builder setObjectBytes(com.google.protobuf.ByteString value)
Required. Name of the object.
string object = 2 [(.google.api.field_behavior) = REQUIRED];
value
- The bytes for object to set.public long getGeneration()
If present, selects a specific revision of this object (as opposed to the latest version, the default).
int64 generation = 3;
getGeneration
in interface GetObjectRequestOrBuilder
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;
value
- The generation to set.public GetObjectRequest.Builder clearGeneration()
If present, selects a specific revision of this object (as opposed to the latest version, the default).
int64 generation = 3;
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;
hasIfGenerationMatch
in interface GetObjectRequestOrBuilder
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;
getIfGenerationMatch
in interface GetObjectRequestOrBuilder
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;
value
- The ifGenerationMatch to set.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;
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;
hasIfGenerationNotMatch
in interface GetObjectRequestOrBuilder
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;
getIfGenerationNotMatch
in interface GetObjectRequestOrBuilder
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;
value
- The ifGenerationNotMatch to set.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;
public boolean hasIfMetagenerationMatch()
Makes the operation conditional on whether the object's current metageneration matches the given value.
optional int64 if_metageneration_match = 6;
hasIfMetagenerationMatch
in interface GetObjectRequestOrBuilder
public long getIfMetagenerationMatch()
Makes the operation conditional on whether the object's current metageneration matches the given value.
optional int64 if_metageneration_match = 6;
getIfMetagenerationMatch
in interface GetObjectRequestOrBuilder
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;
value
- The ifMetagenerationMatch to set.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;
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;
hasIfMetagenerationNotMatch
in interface GetObjectRequestOrBuilder
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;
getIfMetagenerationNotMatch
in interface GetObjectRequestOrBuilder
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;
value
- The ifMetagenerationNotMatch to set.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;
public boolean hasCommonObjectRequestParams()
A set of parameters common to Storage API requests concerning an object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;
hasCommonObjectRequestParams
in interface GetObjectRequestOrBuilder
public CommonObjectRequestParams getCommonObjectRequestParams()
A set of parameters common to Storage API requests concerning an object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;
getCommonObjectRequestParams
in interface GetObjectRequestOrBuilder
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;
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;
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;
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;
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;
public CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder()
A set of parameters common to Storage API requests concerning an object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;
getCommonObjectRequestParamsOrBuilder
in interface GetObjectRequestOrBuilder
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;
hasReadMask
in interface GetObjectRequestOrBuilder
public com.google.protobuf.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;
getReadMask
in interface GetObjectRequestOrBuilder
public GetObjectRequest.Builder setReadMask(com.google.protobuf.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;
public GetObjectRequest.Builder setReadMask(com.google.protobuf.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;
public GetObjectRequest.Builder mergeReadMask(com.google.protobuf.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;
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;
public com.google.protobuf.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;
public com.google.protobuf.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;
getReadMaskOrBuilder
in interface GetObjectRequestOrBuilder
public final GetObjectRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields
in interface com.google.protobuf.Message.Builder
setUnknownFields
in class com.google.protobuf.GeneratedMessageV3.Builder<GetObjectRequest.Builder>
public final GetObjectRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields
in interface com.google.protobuf.Message.Builder
mergeUnknownFields
in class com.google.protobuf.GeneratedMessageV3.Builder<GetObjectRequest.Builder>
Copyright © 2023 Google LLC. All rights reserved.