Represents a Bucket.
Package
@google-cloud/storage-controlConstructors
(constructor)(properties)
constructor(properties?: google.storage.v2.IBucket);Constructs a new Bucket.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBucket
Properties to set |
Properties
acl
public acl: google.storage.v2.IBucketAccessControl[];Bucket acl.
autoclass
public autoclass?: (google.storage.v2.Bucket.IAutoclass|null);Bucket autoclass.
billing
public billing?: (google.storage.v2.Bucket.IBilling|null);Bucket billing.
bucketId
public bucketId: string;Bucket bucketId.
cors
public cors: google.storage.v2.Bucket.ICors[];Bucket cors.
createTime
public createTime?: (google.protobuf.ITimestamp|null);Bucket createTime.
customPlacementConfig
public customPlacementConfig?: (google.storage.v2.Bucket.ICustomPlacementConfig|null);Bucket customPlacementConfig.
defaultEventBasedHold
public defaultEventBasedHold: boolean;Bucket defaultEventBasedHold.
defaultObjectAcl
public defaultObjectAcl: google.storage.v2.IObjectAccessControl[];Bucket defaultObjectAcl.
encryption
public encryption?: (google.storage.v2.Bucket.IEncryption|null);Bucket encryption.
etag
public etag: string;Bucket etag.
hierarchicalNamespace
public hierarchicalNamespace?: (google.storage.v2.Bucket.IHierarchicalNamespace|null);Bucket hierarchicalNamespace.
iamConfig
public iamConfig?: (google.storage.v2.Bucket.IIamConfig|null);Bucket iamConfig.
ipFilter
public ipFilter?: (google.storage.v2.Bucket.IIpFilter|null);Bucket ipFilter.
labels
public labels: { [k: string]: string };Bucket labels.
lifecycle
public lifecycle?: (google.storage.v2.Bucket.ILifecycle|null);Bucket lifecycle.
location
public location: string;Bucket location.
locationType
public locationType: string;Bucket locationType.
logging
public logging?: (google.storage.v2.Bucket.ILogging|null);Bucket logging.
metageneration
public metageneration: (number|Long|string);Bucket metageneration.
name
public name: string;Bucket name.
objectRetention
public objectRetention?: (google.storage.v2.Bucket.IObjectRetention|null);Bucket objectRetention.
owner
public owner?: (google.storage.v2.IOwner|null);Bucket owner.
project
public project: string;Bucket project.
retentionPolicy
public retentionPolicy?: (google.storage.v2.Bucket.IRetentionPolicy|null);Bucket retentionPolicy.
rpo
public rpo: string;Bucket rpo.
satisfiesPzs
public satisfiesPzs: boolean;Bucket satisfiesPzs.
softDeletePolicy
public softDeletePolicy?: (google.storage.v2.Bucket.ISoftDeletePolicy|null);Bucket softDeletePolicy.
storageClass
public storageClass: string;Bucket storageClass.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Bucket updateTime.
versioning
public versioning?: (google.storage.v2.Bucket.IVersioning|null);Bucket versioning.
website
public website?: (google.storage.v2.Bucket.IWebsite|null);Bucket website.
Methods
create(properties)
public static create(properties?: google.storage.v2.IBucket): google.storage.v2.Bucket;Creates a new Bucket instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBucket
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Bucket |
Bucket instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.storage.v2.Bucket;Decodes a Bucket message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Bucket |
Bucket |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.storage.v2.Bucket;Decodes a Bucket message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Bucket |
Bucket |
encode(message, writer)
public static encode(message: google.storage.v2.IBucket, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Bucket message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBucket
Bucket message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.storage.v2.IBucket, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Bucket message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBucket
Bucket message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.storage.v2.Bucket;Creates a Bucket message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Bucket |
Bucket |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Bucket
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Bucket to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.storage.v2.Bucket, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Bucket message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Bucket
Bucket |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Bucket message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|