- 2.48.1 (latest)
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.1
- 2.43.2
- 2.42.0
- 2.41.0
- 2.40.1
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.1
- 2.34.0
- 2.33.0
- 2.32.1
- 2.30.1
- 2.29.1
- 2.28.0
- 2.27.1
- 2.24.0
- 2.23.0
- 2.22.6
- 2.21.0
- 2.20.2
- 2.19.0
- 2.18.0
- 2.17.2
- 2.16.0
- 2.15.1
- 2.14.0
- 2.13.1
- 2.12.0
- 2.11.3
- 2.10.0
- 2.9.3
- 2.8.1
- 2.7.1
- 2.6.1
- 2.5.1
- 2.4.5
- 2.3.0
- 2.2.3
- 2.1.10
public interface BidiReadObjectSpecOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getBucket()
public abstract 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 abstract 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 abstract 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. |
getCommonObjectRequestParamsOrBuilder()
public abstract 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 |
|
getGeneration()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |
getReadHandleOrBuilder()
public abstract 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 abstract 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.
- may be used to mean "all fields". As per https://google.aip.dev/161, this field is deprecated. As an alternative, grpc metadata can be used: https://cloud.google.com/apis/docs/system-parameters#definitions
optional .google.protobuf.FieldMask read_mask = 12 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
FieldMask |
The readMask. |
getReadMaskOrBuilder() (deprecated)
public abstract 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.
- may be used to mean "all fields". As per https://google.aip.dev/161, this field is deprecated. As an alternative, grpc metadata can be used: https://cloud.google.com/apis/docs/system-parameters#definitions
optional .google.protobuf.FieldMask read_mask = 12 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
FieldMaskOrBuilder |
|
getRoutingToken()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.
- may be used to mean "all fields". As per https://google.aip.dev/161, this field is deprecated. As an alternative, grpc metadata can be used: https://cloud.google.com/apis/docs/system-parameters#definitions
optional .google.protobuf.FieldMask read_mask = 12 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the readMask field is set. |
hasRoutingToken()
public abstract 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. |