Class BidiReadObjectSpec.Builder (2.48.1)

public static final class BidiReadObjectSpec.Builder extends GeneratedMessageV3.Builder<BidiReadObjectSpec.Builder> implements BidiReadObjectSpecOrBuilder

Describes the object to read in a BidiReadObject request.

Protobuf type google.storage.v2.BidiReadObjectSpec

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BidiReadObjectSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BidiReadObjectSpec.Builder
Overrides

build()

public BidiReadObjectSpec build()
Returns
Type Description
BidiReadObjectSpec

buildPartial()

public BidiReadObjectSpec buildPartial()
Returns
Type Description
BidiReadObjectSpec

clear()

public BidiReadObjectSpec.Builder clear()
Returns
Type Description
BidiReadObjectSpec.Builder
Overrides

clearBucket()

public BidiReadObjectSpec.Builder clearBucket()

Required. The name of the bucket containing the object to read.

string bucket = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
BidiReadObjectSpec.Builder

This builder for chaining.

clearCommonObjectRequestParams()

public BidiReadObjectSpec.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
BidiReadObjectSpec.Builder

clearField(Descriptors.FieldDescriptor field)

public BidiReadObjectSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BidiReadObjectSpec.Builder
Overrides

clearGeneration()

public BidiReadObjectSpec.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
BidiReadObjectSpec.Builder

This builder for chaining.

clearIfGenerationMatch()

public BidiReadObjectSpec.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
BidiReadObjectSpec.Builder

This builder for chaining.

clearIfGenerationNotMatch()

public BidiReadObjectSpec.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
BidiReadObjectSpec.Builder

This builder for chaining.

clearIfMetagenerationMatch()

public BidiReadObjectSpec.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
BidiReadObjectSpec.Builder

This builder for chaining.

clearIfMetagenerationNotMatch()

public BidiReadObjectSpec.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
BidiReadObjectSpec.Builder

This builder for chaining.

clearObject()

public BidiReadObjectSpec.Builder clearObject()

Required. The name of the object to read.

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

Returns
Type Description
BidiReadObjectSpec.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BidiReadObjectSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BidiReadObjectSpec.Builder
Overrides

clearReadHandle()

public BidiReadObjectSpec.Builder clearReadHandle()

The client can optionally set this field. The read handle is an optimized way of creating new streams. Read handles are generated and periodically refreshed from prior reads.

optional .google.storage.v2.BidiReadHandle read_handle = 13;

Returns
Type Description
BidiReadObjectSpec.Builder

clearReadMask() (deprecated)

public BidiReadObjectSpec.Builder clearReadMask()

Mask specifying which fields to read. The checksummed_data field and its children will always be present. If no mask is specified, will default to all fields except metadata.owner and metadata.acl.

optional .google.protobuf.FieldMask read_mask = 12 [deprecated = true];

Returns
Type Description
BidiReadObjectSpec.Builder

clearRoutingToken()

public BidiReadObjectSpec.Builder clearRoutingToken()

The routing token that influences request routing for the stream. Must be provided if a BidiReadObjectRedirectedError is returned.

optional string routing_token = 14;

Returns
Type Description
BidiReadObjectSpec.Builder

This builder for chaining.

clone()

public BidiReadObjectSpec.Builder clone()
Returns
Type Description
BidiReadObjectSpec.Builder
Overrides

getBucket()

public String getBucket()

Required. The name of the bucket containing the object to read.

string bucket = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The bucket.

getBucketBytes()

public ByteString getBucketBytes()

Required. The name of the bucket containing the object to read.

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 BidiReadObjectSpec getDefaultInstanceForType()
Returns
Type Description
BidiReadObjectSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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. The name of the object to read.

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

Returns
Type Description
String

The object.

getObjectBytes()

public ByteString getObjectBytes()

Required. The name of the object to read.

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

Returns
Type Description
ByteString

The bytes for object.

getReadHandle()

public BidiReadHandle getReadHandle()

The client can optionally set this field. The read handle is an optimized way of creating new streams. Read handles are generated and periodically refreshed from prior reads.

optional .google.storage.v2.BidiReadHandle read_handle = 13;

Returns
Type Description
BidiReadHandle

The readHandle.

getReadHandleBuilder()

public BidiReadHandle.Builder getReadHandleBuilder()

The client can optionally set this field. The read handle is an optimized way of creating new streams. Read handles are generated and periodically refreshed from prior reads.

optional .google.storage.v2.BidiReadHandle read_handle = 13;

Returns
Type Description
BidiReadHandle.Builder

getReadHandleOrBuilder()

public BidiReadHandleOrBuilder getReadHandleOrBuilder()

The client can optionally set this field. The read handle is an optimized way of creating new streams. Read handles are generated and periodically refreshed from prior reads.

optional .google.storage.v2.BidiReadHandle read_handle = 13;

Returns
Type Description
BidiReadHandleOrBuilder

getReadMask() (deprecated)

public FieldMask getReadMask()

Deprecated. google.storage.v2.BidiReadObjectSpec.read_mask is deprecated. See google/storage/v2/storage.proto;l=987

Mask specifying which fields to read. The checksummed_data field and its children will always be present. If no mask is specified, will default to all fields except metadata.owner and metadata.acl.

optional .google.protobuf.FieldMask read_mask = 12 [deprecated = true];

Returns
Type Description
FieldMask

The readMask.

getReadMaskBuilder() (deprecated)

public FieldMask.Builder getReadMaskBuilder()

Mask specifying which fields to read. The checksummed_data field and its children will always be present. If no mask is specified, will default to all fields except metadata.owner and metadata.acl.

optional .google.protobuf.FieldMask read_mask = 12 [deprecated = true];

Returns
Type Description
Builder

getReadMaskOrBuilder() (deprecated)

public FieldMaskOrBuilder getReadMaskOrBuilder()

Mask specifying which fields to read. The checksummed_data field and its children will always be present. If no mask is specified, will default to all fields except metadata.owner and metadata.acl.

optional .google.protobuf.FieldMask read_mask = 12 [deprecated = true];

Returns
Type Description
FieldMaskOrBuilder

getRoutingToken()

public String getRoutingToken()

The routing token that influences request routing for the stream. Must be provided if a BidiReadObjectRedirectedError is returned.

optional string routing_token = 14;

Returns
Type Description
String

The routingToken.

getRoutingTokenBytes()

public ByteString getRoutingTokenBytes()

The routing token that influences request routing for the stream. Must be provided if a BidiReadObjectRedirectedError is returned.

optional string routing_token = 14;

Returns
Type Description
ByteString

The bytes for routingToken.

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.

hasReadHandle()

public boolean hasReadHandle()

The client can optionally set this field. The read handle is an optimized way of creating new streams. Read handles are generated and periodically refreshed from prior reads.

optional .google.storage.v2.BidiReadHandle read_handle = 13;

Returns
Type Description
boolean

Whether the readHandle field is set.

hasReadMask() (deprecated)

public boolean hasReadMask()

Deprecated. google.storage.v2.BidiReadObjectSpec.read_mask is deprecated. See google/storage/v2/storage.proto;l=987

Mask specifying which fields to read. The checksummed_data field and its children will always be present. If no mask is specified, will default to all fields except metadata.owner and metadata.acl.

optional .google.protobuf.FieldMask read_mask = 12 [deprecated = true];

Returns
Type Description
boolean

Whether the readMask field is set.

hasRoutingToken()

public boolean hasRoutingToken()

The routing token that influences request routing for the stream. Must be provided if a BidiReadObjectRedirectedError is returned.

optional string routing_token = 14;

Returns
Type Description
boolean

Whether the routingToken field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCommonObjectRequestParams(CommonObjectRequestParams value)

public BidiReadObjectSpec.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
BidiReadObjectSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BidiReadObjectSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BidiReadObjectSpec.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BidiReadObjectSpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BidiReadObjectSpec.Builder
Overrides

mergeFrom(BidiReadObjectSpec other)

public BidiReadObjectSpec.Builder mergeFrom(BidiReadObjectSpec other)
Parameter
Name Description
other BidiReadObjectSpec
Returns
Type Description
BidiReadObjectSpec.Builder

mergeReadHandle(BidiReadHandle value)

public BidiReadObjectSpec.Builder mergeReadHandle(BidiReadHandle value)

The client can optionally set this field. The read handle is an optimized way of creating new streams. Read handles are generated and periodically refreshed from prior reads.

optional .google.storage.v2.BidiReadHandle read_handle = 13;

Parameter
Name Description
value BidiReadHandle
Returns
Type Description
BidiReadObjectSpec.Builder

mergeReadMask(FieldMask value) (deprecated)

public BidiReadObjectSpec.Builder mergeReadMask(FieldMask value)

Mask specifying which fields to read. The checksummed_data field and its children will always be present. If no mask is specified, will default to all fields except metadata.owner and metadata.acl.

optional .google.protobuf.FieldMask read_mask = 12 [deprecated = true];

Parameter
Name Description
value FieldMask
Returns
Type Description
BidiReadObjectSpec.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BidiReadObjectSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BidiReadObjectSpec.Builder
Overrides

setBucket(String value)

public BidiReadObjectSpec.Builder setBucket(String value)

Required. The name of the bucket containing the object to read.

string bucket = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The bucket to set.

Returns
Type Description
BidiReadObjectSpec.Builder

This builder for chaining.

setBucketBytes(ByteString value)

public BidiReadObjectSpec.Builder setBucketBytes(ByteString value)

Required. The name of the bucket containing the object to read.

string bucket = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for bucket to set.

Returns
Type Description
BidiReadObjectSpec.Builder

This builder for chaining.

setCommonObjectRequestParams(CommonObjectRequestParams value)

public BidiReadObjectSpec.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
BidiReadObjectSpec.Builder

setCommonObjectRequestParams(CommonObjectRequestParams.Builder builderForValue)

public BidiReadObjectSpec.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
BidiReadObjectSpec.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public BidiReadObjectSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BidiReadObjectSpec.Builder
Overrides

setGeneration(long value)

public BidiReadObjectSpec.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 long

The generation to set.

Returns
Type Description
BidiReadObjectSpec.Builder

This builder for chaining.

setIfGenerationMatch(long value)

public BidiReadObjectSpec.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 long

The ifGenerationMatch to set.

Returns
Type Description
BidiReadObjectSpec.Builder

This builder for chaining.

setIfGenerationNotMatch(long value)

public BidiReadObjectSpec.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 long

The ifGenerationNotMatch to set.

Returns
Type Description
BidiReadObjectSpec.Builder

This builder for chaining.

setIfMetagenerationMatch(long value)

public BidiReadObjectSpec.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 long

The ifMetagenerationMatch to set.

Returns
Type Description
BidiReadObjectSpec.Builder

This builder for chaining.

setIfMetagenerationNotMatch(long value)

public BidiReadObjectSpec.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 long

The ifMetagenerationNotMatch to set.

Returns
Type Description
BidiReadObjectSpec.Builder

This builder for chaining.

setObject(String value)

public BidiReadObjectSpec.Builder setObject(String value)

Required. The name of the object to read.

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

Parameter
Name Description
value String

The object to set.

Returns
Type Description
BidiReadObjectSpec.Builder

This builder for chaining.

setObjectBytes(ByteString value)

public BidiReadObjectSpec.Builder setObjectBytes(ByteString value)

Required. The name of the object to read.

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

Parameter
Name Description
value ByteString

The bytes for object to set.

Returns
Type Description
BidiReadObjectSpec.Builder

This builder for chaining.

setReadHandle(BidiReadHandle value)

public BidiReadObjectSpec.Builder setReadHandle(BidiReadHandle value)

The client can optionally set this field. The read handle is an optimized way of creating new streams. Read handles are generated and periodically refreshed from prior reads.

optional .google.storage.v2.BidiReadHandle read_handle = 13;

Parameter
Name Description
value BidiReadHandle
Returns
Type Description
BidiReadObjectSpec.Builder

setReadHandle(BidiReadHandle.Builder builderForValue)

public BidiReadObjectSpec.Builder setReadHandle(BidiReadHandle.Builder builderForValue)

The client can optionally set this field. The read handle is an optimized way of creating new streams. Read handles are generated and periodically refreshed from prior reads.

optional .google.storage.v2.BidiReadHandle read_handle = 13;

Parameter
Name Description
builderForValue BidiReadHandle.Builder
Returns
Type Description
BidiReadObjectSpec.Builder

setReadMask(FieldMask value) (deprecated)

public BidiReadObjectSpec.Builder setReadMask(FieldMask value)

Mask specifying which fields to read. The checksummed_data field and its children will always be present. If no mask is specified, will default to all fields except metadata.owner and metadata.acl.

optional .google.protobuf.FieldMask read_mask = 12 [deprecated = true];

Parameter
Name Description
value FieldMask
Returns
Type Description
BidiReadObjectSpec.Builder

setReadMask(FieldMask.Builder builderForValue) (deprecated)

public BidiReadObjectSpec.Builder setReadMask(FieldMask.Builder builderForValue)

Mask specifying which fields to read. The checksummed_data field and its children will always be present. If no mask is specified, will default to all fields except metadata.owner and metadata.acl.

optional .google.protobuf.FieldMask read_mask = 12 [deprecated = true];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BidiReadObjectSpec.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BidiReadObjectSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BidiReadObjectSpec.Builder
Overrides

setRoutingToken(String value)

public BidiReadObjectSpec.Builder setRoutingToken(String value)

The routing token that influences request routing for the stream. Must be provided if a BidiReadObjectRedirectedError is returned.

optional string routing_token = 14;

Parameter
Name Description
value String

The routingToken to set.

Returns
Type Description
BidiReadObjectSpec.Builder

This builder for chaining.

setRoutingTokenBytes(ByteString value)

public BidiReadObjectSpec.Builder setRoutingTokenBytes(ByteString value)

The routing token that influences request routing for the stream. Must be provided if a BidiReadObjectRedirectedError is returned.

optional string routing_token = 14;

Parameter
Name Description
value ByteString

The bytes for routingToken to set.

Returns
Type Description
BidiReadObjectSpec.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BidiReadObjectSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BidiReadObjectSpec.Builder
Overrides