com.google.storage.v2

Interface GetObjectRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

GetObjectRequest, GetObjectRequest.Builder

public interface GetObjectRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getBucket() Required.
com.google.protobuf.ByteString	getBucketBytes() Required.
CommonObjectRequestParams	getCommonObjectRequestParams() 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.
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.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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getBucket

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:

The bucket.

getBucketBytes

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) = { ... }

Returns:

The bytes for bucket.

getObject

String getObject()

 Required. Name of the object.
 

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

Returns:

The object.

getObjectBytes

com.google.protobuf.ByteString getObjectBytes()

 Required. Name of the object.
 

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

Returns:

The bytes for object.

getGeneration

long getGeneration()

 If present, selects a specific revision of this object (as opposed to the
 latest version, the default).
 

int64 generation = 3;

Returns:

The generation.

hasIfGenerationMatch

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:

Whether the ifGenerationMatch field is set.

getIfGenerationMatch

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:

The ifGenerationMatch.

hasIfGenerationNotMatch

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:

Whether the ifGenerationNotMatch field is set.

getIfGenerationNotMatch

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:

The ifGenerationNotMatch.

hasIfMetagenerationMatch

boolean hasIfMetagenerationMatch()

 Makes the operation conditional on whether the object's current
 metageneration matches the given value.
 

optional int64 if_metageneration_match = 6;

Returns:

Whether the ifMetagenerationMatch field is set.

getIfMetagenerationMatch

long getIfMetagenerationMatch()

 Makes the operation conditional on whether the object's current
 metageneration matches the given value.
 

optional int64 if_metageneration_match = 6;

Returns:

The ifMetagenerationMatch.

hasIfMetagenerationNotMatch

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:

Whether the ifMetagenerationNotMatch field is set.

getIfMetagenerationNotMatch

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:

The ifMetagenerationNotMatch.

hasCommonObjectRequestParams

boolean hasCommonObjectRequestParams()

 A set of parameters common to Storage API requests concerning an object.
 

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

Returns:

Whether the commonObjectRequestParams field is set.

getCommonObjectRequestParams

CommonObjectRequestParams getCommonObjectRequestParams()

 A set of parameters common to Storage API requests concerning an object.
 

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

Returns:

The commonObjectRequestParams.

getCommonObjectRequestParamsOrBuilder

CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder()

 A set of parameters common to Storage API requests concerning an object.
 

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

hasReadMask

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:

Whether the readMask field is set.

getReadMask

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;

Returns:

The readMask.

getReadMaskOrBuilder

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;