- 2.56.0 (latest)
- 2.55.0
- 2.54.0
- 2.53.3
- 2.52.3
- 2.50.0
- 2.49.0
- 2.48.2
- 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
final
class
Bucket
extends
GeneratedMessageV3
implements
BucketOrBuilder
A bucket.
Protobuf type google.storage.v2.Bucket
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BucketImplements
BucketOrBuilderStatic Fields
ACL_FIELD_NUMBER
public
static
final
int
ACL_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
BILLING_FIELD_NUMBER
public
static
final
int
BILLING_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
BUCKET_ID_FIELD_NUMBER
public
static
final
int
BUCKET_ID_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
CORS_FIELD_NUMBER
public
static
final
int
CORS_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
CREATE_TIME_FIELD_NUMBER
public
static
final
int
CREATE_TIME_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
DEFAULT_EVENT_BASED_HOLD_FIELD_NUMBER
public
static
final
int
DEFAULT_EVENT_BASED_HOLD_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
DEFAULT_OBJECT_ACL_FIELD_NUMBER
public
static
final
int
DEFAULT_OBJECT_ACL_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
ENCRYPTION_FIELD_NUMBER
public
static
final
int
ENCRYPTION_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
IAM_CONFIG_FIELD_NUMBER
public
static
final
int
IAM_CONFIG_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
LABELS_FIELD_NUMBER
public
static
final
int
LABELS_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
LIFECYCLE_FIELD_NUMBER
public
static
final
int
LIFECYCLE_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
LOCATION_FIELD_NUMBER
public
static
final
int
LOCATION_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
LOCATION_TYPE_FIELD_NUMBER
public
static
final
int
LOCATION_TYPE_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
LOGGING_FIELD_NUMBER
public
static
final
int
LOGGING_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
METAGENERATION_FIELD_NUMBER
public
static
final
int
METAGENERATION_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
NAME_FIELD_NUMBER
public
static
final
int
NAME_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
OWNER_FIELD_NUMBER
public
static
final
int
OWNER_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
PROJECT_FIELD_NUMBER
public
static
final
int
PROJECT_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
RETENTION_POLICY_FIELD_NUMBER
public
static
final
int
RETENTION_POLICY_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
SATISFIES_PZS_FIELD_NUMBER
public
static
final
int
SATISFIES_PZS_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
STORAGE_CLASS_FIELD_NUMBER
public
static
final
int
STORAGE_CLASS_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
UPDATE_TIME_FIELD_NUMBER
public
static
final
int
UPDATE_TIME_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
VERSIONING_FIELD_NUMBER
public
static
final
int
VERSIONING_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
WEBSITE_FIELD_NUMBER
public
static
final
int
WEBSITE_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
ZONE_AFFINITY_FIELD_NUMBER
public
static
final
int
ZONE_AFFINITY_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
Static Methods
getDefaultInstance()
public
static
Bucket
getDefaultInstance
()
| Type | Description |
|---|---|
| Bucket |
getDescriptor()
public
static
final
Descriptors
.
Descriptor
getDescriptor
()
| Type | Description |
|---|---|
| Descriptor |
newBuilder()
public
static
Bucket
.
Builder
newBuilder
()
| Type | Description |
|---|---|
| Bucket.Builder |
newBuilder(Bucket prototype)
public
static
Bucket
.
Builder
newBuilder
(
Bucket
prototype
)
| Name | Description |
|---|---|
| prototype | Bucket
|
| Type | Description |
|---|---|
| Bucket.Builder |
parseDelimitedFrom(InputStream input)
public
static
Bucket
parseDelimitedFrom
(
InputStream
input
)
| Name | Description |
|---|---|
| input | InputStream
|
| Type | Description |
|---|---|
| Bucket |
| Type | Description |
|---|---|
| IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Bucket
parseDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
| Name | Description |
| input | InputStream
|
| extensionRegistry | ExtensionRegistryLite
|
| Type | Description |
|---|---|
| Bucket |
| Type | Description |
|---|---|
| IOException |
parseFrom(byte[] data)
public
static
Bucket
parseFrom
(
byte
[]
data
)
| Name | Description |
|---|---|
| data | byte
[]
|
| Type | Description |
|---|---|
| Bucket |
| Type | Description |
|---|---|
| InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
static
Bucket
parseFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
| Name | Description |
| data | byte
[]
|
| extensionRegistry | ExtensionRegistryLite
|
| Type | Description |
|---|---|
| Bucket |
| Type | Description |
|---|---|
| InvalidProtocolBufferException |
parseFrom(ByteString data)
public
static
Bucket
parseFrom
(
ByteString
data
)
| Name | Description |
|---|---|
| data | ByteString
|
| Type | Description |
|---|---|
| Bucket |
| Type | Description |
|---|---|
| InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public
static
Bucket
parseFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
| Name | Description |
| data | ByteString
|
| extensionRegistry | ExtensionRegistryLite
|
| Type | Description |
|---|---|
| Bucket |
| Type | Description |
|---|---|
| InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public
static
Bucket
parseFrom
(
CodedInputStream
input
)
| Name | Description |
|---|---|
| input | CodedInputStream
|
| Type | Description |
|---|---|
| Bucket |
| Type | Description |
|---|---|
| IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Bucket
parseFrom
(
CodedInputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
| Name | Description |
| input | CodedInputStream
|
| extensionRegistry | ExtensionRegistryLite
|
| Type | Description |
|---|---|
| Bucket |
| Type | Description |
|---|---|
| IOException |
parseFrom(InputStream input)
public
static
Bucket
parseFrom
(
InputStream
input
)
| Name | Description |
|---|---|
| input | InputStream
|
| Type | Description |
|---|---|
| Bucket |
| Type | Description |
|---|---|
| IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Bucket
parseFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
| Name | Description |
| input | InputStream
|
| extensionRegistry | ExtensionRegistryLite
|
| Type | Description |
|---|---|
| Bucket |
| Type | Description |
|---|---|
| IOException |
parseFrom(ByteBuffer data)
public
static
Bucket
parseFrom
(
ByteBuffer
data
)
| Name | Description |
|---|---|
| data | ByteBuffer
|
| Type | Description |
|---|---|
| Bucket |
| Type | Description |
|---|---|
| InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public
static
Bucket
parseFrom
(
ByteBuffer
data
,
ExtensionRegistryLite
extensionRegistry
)
| Name | Description |
| data | ByteBuffer
|
| extensionRegistry | ExtensionRegistryLite
|
| Type | Description |
|---|---|
| Bucket |
| Type | Description |
|---|---|
| InvalidProtocolBufferException |
parser()
public
static
Parser<Bucket>
parser
()
| Type | Description |
|---|---|
| Parser < Bucket > |
Methods
containsLabels(String key)
public
boolean
containsLabels
(
String
key
)
User-provided labels, in key/value pairs.
map<string, string> labels = 15;
| Name | Description |
|---|---|
| key | String
|
| Type | Description |
|---|---|
| boolean |
equals(Object obj)
public
boolean
equals
(
Object
obj
)
| Name | Description |
|---|---|
| obj | Object
|
| Type | Description |
|---|---|
| boolean |
getAcl(int index)
public
BucketAccessControl
getAcl
(
int
index
)
Access controls on the bucket. If iamConfig.uniformBucketLevelAccess is enabled on this bucket, requests to set, read, or modify acl is an error.
repeated .google.storage.v2.BucketAccessControl acl = 8;
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| BucketAccessControl |
getAclCount()
public
int
getAclCount
()
Access controls on the bucket. If iamConfig.uniformBucketLevelAccess is enabled on this bucket, requests to set, read, or modify acl is an error.
repeated .google.storage.v2.BucketAccessControl acl = 8;
| Type | Description |
|---|---|
| int |
getAclList()
public
List<BucketAccessControl>
getAclList
()
Access controls on the bucket. If iamConfig.uniformBucketLevelAccess is enabled on this bucket, requests to set, read, or modify acl is an error.
repeated .google.storage.v2.BucketAccessControl acl = 8;
| Type | Description |
|---|---|
| List < BucketAccessControl > |
getAclOrBuilder(int index)
public
BucketAccessControlOrBuilder
getAclOrBuilder
(
int
index
)
Access controls on the bucket. If iamConfig.uniformBucketLevelAccess is enabled on this bucket, requests to set, read, or modify acl is an error.
repeated .google.storage.v2.BucketAccessControl acl = 8;
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| BucketAccessControlOrBuilder |
getAclOrBuilderList()
public
List
< ?
extends
BucketAccessControlOrBuilder
>
getAclOrBuilderList
()
Access controls on the bucket. If iamConfig.uniformBucketLevelAccess is enabled on this bucket, requests to set, read, or modify acl is an error.
repeated .google.storage.v2.BucketAccessControl acl = 8;
| Type | Description |
|---|---|
| List < ? extends com.google.storage.v2.BucketAccessControlOrBuilder > |
getBilling()
public
Bucket
.
Billing
getBilling
()
The bucket's billing config.
.google.storage.v2.Bucket.Billing billing = 21;
| Type | Description |
|---|---|
| Bucket.Billing | The billing. |
getBillingOrBuilder()
public
Bucket
.
BillingOrBuilder
getBillingOrBuilder
()
The bucket's billing config.
.google.storage.v2.Bucket.Billing billing = 21;
| Type | Description |
|---|---|
| Bucket.BillingOrBuilder |
getBucketId()
public
String
getBucketId
()
Output only. The user-chosen part of the bucket name. The {bucket}
portion of the name
field. For globally unique buckets, this is equal to the "bucket
name" of other Cloud Storage APIs. Example: "pub".
string bucket_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
|---|---|
| String | The bucketId. |
getBucketIdBytes()
public
ByteString
getBucketIdBytes
()
Output only. The user-chosen part of the bucket name. The {bucket}
portion of the name
field. For globally unique buckets, this is equal to the "bucket
name" of other Cloud Storage APIs. Example: "pub".
string bucket_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
|---|---|
| ByteString | The bytes for bucketId. |
getCors(int index)
public
Bucket
.
Cors
getCors
(
int
index
)
The bucket's https://www.w3.org/TR/cors/ (CORS) config.
repeated .google.storage.v2.Bucket.Cors cors = 12;
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| Bucket.Cors |
getCorsCount()
public
int
getCorsCount
()
The bucket's https://www.w3.org/TR/cors/ (CORS) config.
repeated .google.storage.v2.Bucket.Cors cors = 12;
| Type | Description |
|---|---|
| int |
getCorsList()
public
List<Bucket
.
Cors
>
getCorsList
()
The bucket's https://www.w3.org/TR/cors/ (CORS) config.
repeated .google.storage.v2.Bucket.Cors cors = 12;
| Type | Description |
|---|---|
| List < Cors > |
getCorsOrBuilder(int index)
public
Bucket
.
CorsOrBuilder
getCorsOrBuilder
(
int
index
)
The bucket's https://www.w3.org/TR/cors/ (CORS) config.
repeated .google.storage.v2.Bucket.Cors cors = 12;
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| Bucket.CorsOrBuilder |
getCorsOrBuilderList()
public
List
< ?
extends
Bucket
.
CorsOrBuilder
>
getCorsOrBuilderList
()
The bucket's https://www.w3.org/TR/cors/ (CORS) config.
repeated .google.storage.v2.Bucket.Cors cors = 12;
| Type | Description |
|---|---|
| List < ? extends com.google.storage.v2.Bucket.CorsOrBuilder > |
getCreateTime()
public
Timestamp
getCreateTime
()
Output only. The creation time of the bucket in https://tools.ietf.org/html/rfc3339 format. Attempting to set or update this field will result in a FieldViolation .
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
|---|---|
| Timestamp | The createTime. |
getCreateTimeOrBuilder()
public
TimestampOrBuilder
getCreateTimeOrBuilder
()
Output only. The creation time of the bucket in https://tools.ietf.org/html/rfc3339 format. Attempting to set or update this field will result in a FieldViolation .
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
|---|---|
| TimestampOrBuilder |
getDefaultEventBasedHold()
public
boolean
getDefaultEventBasedHold
()
The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.
bool default_event_based_hold = 14;
| Type | Description |
| boolean | The defaultEventBasedHold. |
getDefaultInstanceForType()
public
Bucket
getDefaultInstanceForType
()
| Type | Description |
|---|---|
| Bucket |
getDefaultObjectAcl(int index)
public
ObjectAccessControl
getDefaultObjectAcl
(
int
index
)
Default access controls to apply to new objects when no ACL is provided. If iamConfig.uniformBucketLevelAccess is enabled on this bucket, requests to set, read, or modify acl is an error.
repeated .google.storage.v2.ObjectAccessControl default_object_acl = 9;
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| ObjectAccessControl |
getDefaultObjectAclCount()
public
int
getDefaultObjectAclCount
()
Default access controls to apply to new objects when no ACL is provided. If iamConfig.uniformBucketLevelAccess is enabled on this bucket, requests to set, read, or modify acl is an error.
repeated .google.storage.v2.ObjectAccessControl default_object_acl = 9;
| Type | Description |
|---|---|
| int |
getDefaultObjectAclList()
public
List<ObjectAccessControl>
getDefaultObjectAclList
()
Default access controls to apply to new objects when no ACL is provided. If iamConfig.uniformBucketLevelAccess is enabled on this bucket, requests to set, read, or modify acl is an error.
repeated .google.storage.v2.ObjectAccessControl default_object_acl = 9;
| Type | Description |
|---|---|
| List < ObjectAccessControl > |
getDefaultObjectAclOrBuilder(int index)
public
ObjectAccessControlOrBuilder
getDefaultObjectAclOrBuilder
(
int
index
)
Default access controls to apply to new objects when no ACL is provided. If iamConfig.uniformBucketLevelAccess is enabled on this bucket, requests to set, read, or modify acl is an error.
repeated .google.storage.v2.ObjectAccessControl default_object_acl = 9;
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| ObjectAccessControlOrBuilder |
getDefaultObjectAclOrBuilderList()
public
List
< ?
extends
ObjectAccessControlOrBuilder
>
getDefaultObjectAclOrBuilderList
()
Default access controls to apply to new objects when no ACL is provided. If iamConfig.uniformBucketLevelAccess is enabled on this bucket, requests to set, read, or modify acl is an error.
repeated .google.storage.v2.ObjectAccessControl default_object_acl = 9;
| Type | Description |
|---|---|
| List < ? extends com.google.storage.v2.ObjectAccessControlOrBuilder > |
getEncryption()
public
Bucket
.
Encryption
getEncryption
()
Encryption config for a bucket.
.google.storage.v2.Bucket.Encryption encryption = 20;
| Type | Description |
|---|---|
| Bucket.Encryption | The encryption. |
getEncryptionOrBuilder()
public
Bucket
.
EncryptionOrBuilder
getEncryptionOrBuilder
()
Encryption config for a bucket.
.google.storage.v2.Bucket.Encryption encryption = 20;
| Type | Description |
|---|---|
| Bucket.EncryptionOrBuilder |
getIamConfig()
public
Bucket
.
IamConfig
getIamConfig
()
The bucket's IAM config.
.google.storage.v2.Bucket.IamConfig iam_config = 23;
| Type | Description |
|---|---|
| Bucket.IamConfig | The iamConfig. |
getIamConfigOrBuilder()
public
Bucket
.
IamConfigOrBuilder
getIamConfigOrBuilder
()
The bucket's IAM config.
.google.storage.v2.Bucket.IamConfig iam_config = 23;
| Type | Description |
|---|---|
| Bucket.IamConfigOrBuilder |
getLabels()
public
Map<String
,
String
>
getLabels
()
Use #getLabelsMap() instead.
| Type | Description |
|---|---|
| Map < String , String > |
getLabelsCount()
public
int
getLabelsCount
()
User-provided labels, in key/value pairs.
map<string, string> labels = 15;
| Type | Description |
|---|---|
| int |
getLabelsMap()
public
Map<String
,
String
>
getLabelsMap
()
User-provided labels, in key/value pairs.
map<string, string> labels = 15;
| Type | Description |
|---|---|
| Map < String , String > |
getLabelsOrDefault(String key, String defaultValue)
public
String
getLabelsOrDefault
(
String
key
,
String
defaultValue
)
User-provided labels, in key/value pairs.
map<string, string> labels = 15;
| Name | Description |
|---|---|
| key | String
|
| defaultValue | String
|
| Type | Description |
|---|---|
| String |
getLabelsOrThrow(String key)
public
String
getLabelsOrThrow
(
String
key
)
User-provided labels, in key/value pairs.
map<string, string> labels = 15;
| Name | Description |
|---|---|
| key | String
|
| Type | Description |
|---|---|
| String |
getLifecycle()
public
Bucket
.
Lifecycle
getLifecycle
()
The bucket's lifecycle config. See [https://developers.google.com/storage/docs/lifecycle]Lifecycle Management] for more information.
.google.storage.v2.Bucket.Lifecycle lifecycle = 10;
| Type | Description |
|---|---|
| Bucket.Lifecycle | The lifecycle. |
getLifecycleOrBuilder()
public
Bucket
.
LifecycleOrBuilder
getLifecycleOrBuilder
()
The bucket's lifecycle config. See [https://developers.google.com/storage/docs/lifecycle]Lifecycle Management] for more information.
.google.storage.v2.Bucket.Lifecycle lifecycle = 10;
| Type | Description |
|---|---|
| Bucket.LifecycleOrBuilder |
getLocation()
public
String
getLocation
()
Immutable. The location of the bucket. Object data for objects in the bucket resides
in physical storage within this region. Defaults to US
. See the https://developers.google.com/storage/docs/concepts-techniques#specifyinglocations
"
for the authoritative list. Attempting to update this field after
the bucket is created will result in an error.
string location = 5 [(.google.api.field_behavior) = IMMUTABLE];
| Type | Description |
|---|---|
| String | The location. |
getLocationBytes()
public
ByteString
getLocationBytes
()
Immutable. The location of the bucket. Object data for objects in the bucket resides
in physical storage within this region. Defaults to US
. See the https://developers.google.com/storage/docs/concepts-techniques#specifyinglocations
"
for the authoritative list. Attempting to update this field after
the bucket is created will result in an error.
string location = 5 [(.google.api.field_behavior) = IMMUTABLE];
| Type | Description |
|---|---|
| ByteString | The bytes for location. |
getLocationType()
public
String
getLocationType
()
Output only. The location type of the bucket (region, dual-region, multi-region, etc).
string location_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
|---|---|
| String | The locationType. |
getLocationTypeBytes()
public
ByteString
getLocationTypeBytes
()
Output only. The location type of the bucket (region, dual-region, multi-region, etc).
string location_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| ByteString | The bytes for locationType. |
getLogging()
public
Bucket
.
Logging
getLogging
()
The bucket's logging config, which defines the destination bucket and name prefix (if any) for the current bucket's logs.
.google.storage.v2.Bucket.Logging logging = 18;
| Type | Description |
|---|---|
| Bucket.Logging | The logging. |
getLoggingOrBuilder()
public
Bucket
.
LoggingOrBuilder
getLoggingOrBuilder
()
The bucket's logging config, which defines the destination bucket and name prefix (if any) for the current bucket's logs.
.google.storage.v2.Bucket.Logging logging = 18;
| Type | Description |
|---|---|
| Bucket.LoggingOrBuilder |
getMetageneration()
public
long
getMetageneration
()
Output only. The metadata generation of this bucket. Attempting to set or update this field will result in a FieldViolation .
int64 metageneration = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
|---|---|
| long | The metageneration. |
getName()
public
String
getName
()
Immutable. The name of the bucket.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Type | Description |
|---|---|
| String | The name. |
getNameBytes()
public
ByteString
getNameBytes
()
Immutable. The name of the bucket.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Type | Description |
|---|---|
| ByteString | The bytes for name. |
getOwner()
public
Owner
getOwner
()
Output only. The owner of the bucket. This is always the project team's owner group.
.google.storage.v2.Owner owner = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
|---|---|
| Owner | The owner. |
getOwnerOrBuilder()
public
OwnerOrBuilder
getOwnerOrBuilder
()
Output only. The owner of the bucket. This is always the project team's owner group.
.google.storage.v2.Owner owner = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
|---|---|
| OwnerOrBuilder |
getParserForType()
public
Parser<Bucket>
getParserForType
()
| Type | Description |
|---|---|
| Parser < Bucket > |
getProject()
public
String
getProject
()
Immutable. The project which owns this bucket.
string project = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Type | Description |
|---|---|
| String | The project. |
getProjectBytes()
public
ByteString
getProjectBytes
()
Immutable. The project which owns this bucket.
string project = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Type | Description |
|---|---|
| ByteString | The bytes for project. |
getRetentionPolicy()
public
Bucket
.
RetentionPolicy
getRetentionPolicy
()
The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.
.google.storage.v2.Bucket.RetentionPolicy retention_policy = 22;
| Type | Description |
|---|---|
| Bucket.RetentionPolicy | The retentionPolicy. |
getRetentionPolicyOrBuilder()
public
Bucket
.
RetentionPolicyOrBuilder
getRetentionPolicyOrBuilder
()
The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.
.google.storage.v2.Bucket.RetentionPolicy retention_policy = 22;
| Type | Description |
|---|---|
| Bucket.RetentionPolicyOrBuilder |
getSatisfiesPzs()
public
boolean
getSatisfiesPzs
()
Reserved for future use.
bool satisfies_pzs = 25;
| Type | Description |
|---|---|
| boolean | The satisfiesPzs. |
getSerializedSize()
public
int
getSerializedSize
()
| Type | Description |
|---|---|
| int |
getStorageClass()
public
String
getStorageClass
()
The bucket's default storage class, used whenever no storageClass is
specified for a newly-created object. This defines how objects in the
bucket are stored and determines the SLA and the cost of storage.
If this value is not specified when the bucket is created, it will default
to STANDARD
. For more information, see https://developers.google.com/storage/docs/storage-classes
.
string storage_class = 7;
| Type | Description |
|---|---|
| String | The storageClass. |
getStorageClassBytes()
public
ByteString
getStorageClassBytes
()
The bucket's default storage class, used whenever no storageClass is
specified for a newly-created object. This defines how objects in the
bucket are stored and determines the SLA and the cost of storage.
If this value is not specified when the bucket is created, it will default
to STANDARD
. For more information, see https://developers.google.com/storage/docs/storage-classes
.
string storage_class = 7;
| Type | Description |
| ByteString | The bytes for storageClass. |
getUnknownFields()
public
final
UnknownFieldSet
getUnknownFields
()
| Type | Description |
|---|---|
| UnknownFieldSet |
getUpdateTime()
public
Timestamp
getUpdateTime
()
Output only. The modification time of the bucket. Attempting to set or update this field will result in a FieldViolation .
.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
|---|---|
| Timestamp | The updateTime. |
getUpdateTimeOrBuilder()
public
TimestampOrBuilder
getUpdateTimeOrBuilder
()
Output only. The modification time of the bucket. Attempting to set or update this field will result in a FieldViolation .
.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
|---|---|
| TimestampOrBuilder |
getVersioning()
public
Bucket
.
Versioning
getVersioning
()
The bucket's versioning config.
.google.storage.v2.Bucket.Versioning versioning = 17;
| Type | Description |
|---|---|
| Bucket.Versioning | The versioning. |
getVersioningOrBuilder()
public
Bucket
.
VersioningOrBuilder
getVersioningOrBuilder
()
The bucket's versioning config.
.google.storage.v2.Bucket.Versioning versioning = 17;
| Type | Description |
|---|---|
| Bucket.VersioningOrBuilder |
getWebsite()
public
Bucket
.
Website
getWebsite
()
The bucket's website config, controlling how the service behaves when accessing bucket contents as a web site. See the https://cloud.google.com/storage/docs/static-website for more information.
.google.storage.v2.Bucket.Website website = 16;
| Type | Description |
|---|---|
| Bucket.Website | The website. |
getWebsiteOrBuilder()
public
Bucket
.
WebsiteOrBuilder
getWebsiteOrBuilder
()
The bucket's website config, controlling how the service behaves when accessing bucket contents as a web site. See the https://cloud.google.com/storage/docs/static-website for more information.
.google.storage.v2.Bucket.Website website = 16;
| Type | Description |
|---|---|
| Bucket.WebsiteOrBuilder |
getZoneAffinity(int index)
public
String
getZoneAffinity
(
int
index
)
Immutable. The zone or zones from which the bucket is intended to use zonal quota. Requests for data from outside the specified affinities are still allowed but won't be able to use zonal quota. The values are case-insensitive. Attempting to update this field after bucket is created will result in an error.
repeated string zone_affinity = 24 [deprecated = true, (.google.api.field_behavior) = IMMUTABLE];
| Name | Description |
| index | int
The index of the element to return. |
| Type | Description |
| String | The zoneAffinity at the given index. |
getZoneAffinityBytes(int index)
public
ByteString
getZoneAffinityBytes
(
int
index
)
Immutable. The zone or zones from which the bucket is intended to use zonal quota. Requests for data from outside the specified affinities are still allowed but won't be able to use zonal quota. The values are case-insensitive. Attempting to update this field after bucket is created will result in an error.
repeated string zone_affinity = 24 [deprecated = true, (.google.api.field_behavior) = IMMUTABLE];
| Name | Description |
| index | int
The index of the value to return. |
| Type | Description |
| ByteString | The bytes of the zoneAffinity at the given index. |
getZoneAffinityCount()
public
int
getZoneAffinityCount
()
Immutable. The zone or zones from which the bucket is intended to use zonal quota. Requests for data from outside the specified affinities are still allowed but won't be able to use zonal quota. The values are case-insensitive. Attempting to update this field after bucket is created will result in an error.
repeated string zone_affinity = 24 [deprecated = true, (.google.api.field_behavior) = IMMUTABLE];
| Type | Description |
| int | The count of zoneAffinity. |
getZoneAffinityList()
public
ProtocolStringList
getZoneAffinityList
()
Immutable. The zone or zones from which the bucket is intended to use zonal quota. Requests for data from outside the specified affinities are still allowed but won't be able to use zonal quota. The values are case-insensitive. Attempting to update this field after bucket is created will result in an error.
repeated string zone_affinity = 24 [deprecated = true, (.google.api.field_behavior) = IMMUTABLE];
| Type | Description |
| ProtocolStringList | A list containing the zoneAffinity. |
hasBilling()
public
boolean
hasBilling
()
The bucket's billing config.
.google.storage.v2.Bucket.Billing billing = 21;
| Type | Description |
| boolean | Whether the billing field is set. |
hasCreateTime()
public
boolean
hasCreateTime
()
Output only. The creation time of the bucket in https://tools.ietf.org/html/rfc3339 format. Attempting to set or update this field will result in a FieldViolation .
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the createTime field is set. |
hasEncryption()
public
boolean
hasEncryption
()
Encryption config for a bucket.
.google.storage.v2.Bucket.Encryption encryption = 20;
| Type | Description |
| boolean | Whether the encryption field is set. |
hasIamConfig()
public
boolean
hasIamConfig
()
The bucket's IAM config.
.google.storage.v2.Bucket.IamConfig iam_config = 23;
| Type | Description |
| boolean | Whether the iamConfig field is set. |
hasLifecycle()
public
boolean
hasLifecycle
()
The bucket's lifecycle config. See [https://developers.google.com/storage/docs/lifecycle]Lifecycle Management] for more information.
.google.storage.v2.Bucket.Lifecycle lifecycle = 10;
| Type | Description |
| boolean | Whether the lifecycle field is set. |
hasLogging()
public
boolean
hasLogging
()
The bucket's logging config, which defines the destination bucket and name prefix (if any) for the current bucket's logs.
.google.storage.v2.Bucket.Logging logging = 18;
| Type | Description |
| boolean | Whether the logging field is set. |
hasOwner()
public
boolean
hasOwner
()
Output only. The owner of the bucket. This is always the project team's owner group.
.google.storage.v2.Owner owner = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the owner field is set. |
hasRetentionPolicy()
public
boolean
hasRetentionPolicy
()
The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.
.google.storage.v2.Bucket.RetentionPolicy retention_policy = 22;
| Type | Description |
| boolean | Whether the retentionPolicy field is set. |
hasUpdateTime()
public
boolean
hasUpdateTime
()
Output only. The modification time of the bucket. Attempting to set or update this field will result in a FieldViolation .
.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the updateTime field is set. |
hasVersioning()
public
boolean
hasVersioning
()
The bucket's versioning config.
.google.storage.v2.Bucket.Versioning versioning = 17;
| Type | Description |
| boolean | Whether the versioning field is set. |
hasWebsite()
public
boolean
hasWebsite
()
The bucket's website config, controlling how the service behaves when accessing bucket contents as a web site. See the https://cloud.google.com/storage/docs/static-website for more information.
.google.storage.v2.Bucket.Website website = 16;
| Type | Description |
| boolean | Whether the website field is set. |
hashCode()
public
int
hashCode
()
| Type | Description |
|---|---|
| int |
internalGetFieldAccessorTable()
protected
GeneratedMessageV3
.
FieldAccessorTable
internalGetFieldAccessorTable
()
| Type | Description |
|---|---|
| FieldAccessorTable |
internalGetMapField(int number)
protected
MapField
internalGetMapField
(
int
number
)
| Name | Description |
|---|---|
| number | int
|
| Type | Description |
|---|---|
| MapField |
isInitialized()
public
final
boolean
isInitialized
()
| Type | Description |
|---|---|
| boolean |
newBuilderForType()
public
Bucket
.
Builder
newBuilderForType
()
| Type | Description |
|---|---|
| Bucket.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected
Bucket
.
Builder
newBuilderForType
(
GeneratedMessageV3
.
BuilderParent
parent
)
| Name | Description |
|---|---|
| parent | BuilderParent
|
| Type | Description |
|---|---|
| Bucket.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected
Object
newInstance
(
GeneratedMessageV3
.
UnusedPrivateParameter
unused
)
| Name | Description |
| unused | UnusedPrivateParameter
|
| Type | Description |
|---|---|
| Object |
toBuilder()
public
Bucket
.
Builder
toBuilder
()
| Type | Description |
|---|---|
| Bucket.Builder |
writeTo(CodedOutputStream output)
public
void
writeTo
(
CodedOutputStream
output
)
| Name | Description |
|---|---|
| output | CodedOutputStream
|
| Type | Description |
|---|---|
| IOException |
