public final class BidiReadObjectSpec extends GeneratedMessageV3 implements BidiReadObjectSpecOrBuilder
Describes the object to read in a BidiReadObject request.
Protobuf type google.storage.v2.BidiReadObjectSpec
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
BUCKET_FIELD_NUMBER
public static final int BUCKET_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
public static final int COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GENERATION_FIELD_NUMBER
public static final int GENERATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
IF_GENERATION_MATCH_FIELD_NUMBER
public static final int IF_GENERATION_MATCH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
IF_GENERATION_NOT_MATCH_FIELD_NUMBER
public static final int IF_GENERATION_NOT_MATCH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int IF_METAGENERATION_MATCH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
OBJECT_FIELD_NUMBER
public static final int OBJECT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
READ_HANDLE_FIELD_NUMBER
public static final int READ_HANDLE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
READ_MASK_FIELD_NUMBER
public static final int READ_MASK_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ROUTING_TOKEN_FIELD_NUMBER
public static final int ROUTING_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static BidiReadObjectSpec getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static BidiReadObjectSpec.Builder newBuilder()
newBuilder(BidiReadObjectSpec prototype)
public static BidiReadObjectSpec.Builder newBuilder(BidiReadObjectSpec prototype)
public static BidiReadObjectSpec parseDelimitedFrom(InputStream input)
public static BidiReadObjectSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static BidiReadObjectSpec parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BidiReadObjectSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static BidiReadObjectSpec parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BidiReadObjectSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BidiReadObjectSpec parseFrom(CodedInputStream input)
public static BidiReadObjectSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BidiReadObjectSpec parseFrom(InputStream input)
public static BidiReadObjectSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static BidiReadObjectSpec parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BidiReadObjectSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<BidiReadObjectSpec> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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()
Optional. A set of parameters common to Storage API requests concerning an
object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8 [(.google.api.field_behavior) = OPTIONAL];
getCommonObjectRequestParamsOrBuilder()
public CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder()
Optional. A set of parameters common to Storage API requests concerning an
object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8 [(.google.api.field_behavior) = OPTIONAL];
getDefaultInstanceForType()
public BidiReadObjectSpec getDefaultInstanceForType()
getGeneration()
public long getGeneration()
Optional. If present, selects a specific revision of this object (as
opposed to the latest version, the default).
int64 generation = 3 [(.google.api.field_behavior) = OPTIONAL];
| 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.
|
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.
|
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.
|
getParserForType()
public Parser<BidiReadObjectSpec> getParserForType()
Overrides
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;
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;
getReadMask() (deprecated)
public FieldMask getReadMask()
Deprecated. google.storage.v2.BidiReadObjectSpec.read_mask is deprecated. See
google/storage/v2/storage.proto;l=1027
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.
|
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];
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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hasCommonObjectRequestParams()
public boolean hasCommonObjectRequestParams()
Optional. A set of parameters common to Storage API requests concerning an
object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8 [(.google.api.field_behavior) = OPTIONAL];
| 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.
|
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.
|
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=1027
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public BidiReadObjectSpec.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BidiReadObjectSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public BidiReadObjectSpec.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
