Class protos.google.cloud.compute.v1.BackendBucket (4.1.0)

Represents a BackendBucket.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1.IBackendBucket);

Constructs a new BackendBucket.

Parameter
NameDescription
properties IBackendBucket

Properties to set

Properties

_bucketName

public _bucketName?: "bucketName";

BackendBucket _bucketName.

_cdnPolicy

public _cdnPolicy?: "cdnPolicy";

BackendBucket _cdnPolicy.

_compressionMode

public _compressionMode?: "compressionMode";

BackendBucket _compressionMode.

_creationTimestamp

public _creationTimestamp?: "creationTimestamp";

BackendBucket _creationTimestamp.

_description

public _description?: "description";

BackendBucket _description.

_edgeSecurityPolicy

public _edgeSecurityPolicy?: "edgeSecurityPolicy";

BackendBucket _edgeSecurityPolicy.

_enableCdn

public _enableCdn?: "enableCdn";

BackendBucket _enableCdn.

_id

public _id?: "id";

BackendBucket _id.

_kind

public _kind?: "kind";

BackendBucket _kind.

_name

public _name?: "name";

BackendBucket _name.

public _selfLink?: "selfLink";

BackendBucket _selfLink.

bucketName

public bucketName?: (string|null);

BackendBucket bucketName.

cdnPolicy

public cdnPolicy?: (google.cloud.compute.v1.IBackendBucketCdnPolicy|null);

BackendBucket cdnPolicy.

compressionMode

public compressionMode?: (string|null);

BackendBucket compressionMode.

creationTimestamp

public creationTimestamp?: (string|null);

BackendBucket creationTimestamp.

customResponseHeaders

public customResponseHeaders: string[];

BackendBucket customResponseHeaders.

description

public description?: (string|null);

BackendBucket description.

edgeSecurityPolicy

public edgeSecurityPolicy?: (string|null);

BackendBucket edgeSecurityPolicy.

enableCdn

public enableCdn?: (boolean|null);

BackendBucket enableCdn.

id

public id?: (number|Long|string|null);

BackendBucket id.

kind

public kind?: (string|null);

BackendBucket kind.

name

public name?: (string|null);

BackendBucket name.

public selfLink?: (string|null);

BackendBucket selfLink.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IBackendBucket): google.cloud.compute.v1.BackendBucket;

Creates a new BackendBucket instance using the specified properties.

Parameter
NameDescription
properties IBackendBucket

Properties to set

Returns
TypeDescription
BackendBucket

BackendBucket instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1.BackendBucket;

Decodes a BackendBucket message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
BackendBucket

BackendBucket

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.BackendBucket;

Decodes a BackendBucket message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
BackendBucket

BackendBucket

encode(message, writer)

public static encode(message: google.cloud.compute.v1.IBackendBucket, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified BackendBucket message. Does not implicitly messages.

Parameters
NameDescription
message IBackendBucket

BackendBucket message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.compute.v1.IBackendBucket, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified BackendBucket message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IBackendBucket

BackendBucket message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.compute.v1.BackendBucket;

Creates a BackendBucket message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
BackendBucket

BackendBucket

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for BackendBucket

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this BackendBucket to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.compute.v1.BackendBucket, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a BackendBucket message. Also converts values to other types if specified.

Parameters
NameDescription
message BackendBucket

BackendBucket

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a BackendBucket message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not