Class protos.google.cloud.compute.v1.BackendBucketCdnPolicy (4.3.0)

Represents a BackendBucketCdnPolicy.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new BackendBucketCdnPolicy.

Parameter
Name Description
properties IBackendBucketCdnPolicy

Properties to set

Properties

_cacheKeyPolicy

public _cacheKeyPolicy?: "cacheKeyPolicy";

BackendBucketCdnPolicy _cacheKeyPolicy.

_cacheMode

public _cacheMode?: "cacheMode";

BackendBucketCdnPolicy _cacheMode.

_clientTtl

public _clientTtl?: "clientTtl";

BackendBucketCdnPolicy _clientTtl.

_defaultTtl

public _defaultTtl?: "defaultTtl";

BackendBucketCdnPolicy _defaultTtl.

_maxTtl

public _maxTtl?: "maxTtl";

BackendBucketCdnPolicy _maxTtl.

_negativeCaching

public _negativeCaching?: "negativeCaching";

BackendBucketCdnPolicy _negativeCaching.

_requestCoalescing

public _requestCoalescing?: "requestCoalescing";

BackendBucketCdnPolicy _requestCoalescing.

_serveWhileStale

public _serveWhileStale?: "serveWhileStale";

BackendBucketCdnPolicy _serveWhileStale.

_signedUrlCacheMaxAgeSec

public _signedUrlCacheMaxAgeSec?: "signedUrlCacheMaxAgeSec";

BackendBucketCdnPolicy _signedUrlCacheMaxAgeSec.

bypassCacheOnRequestHeaders

public bypassCacheOnRequestHeaders: google.cloud.compute.v1.IBackendBucketCdnPolicyBypassCacheOnRequestHeader[];

BackendBucketCdnPolicy bypassCacheOnRequestHeaders.

cacheKeyPolicy

public cacheKeyPolicy?: (google.cloud.compute.v1.IBackendBucketCdnPolicyCacheKeyPolicy|null);

BackendBucketCdnPolicy cacheKeyPolicy.

cacheMode

public cacheMode?: (string|null);

BackendBucketCdnPolicy cacheMode.

clientTtl

public clientTtl?: (number|null);

BackendBucketCdnPolicy clientTtl.

defaultTtl

public defaultTtl?: (number|null);

BackendBucketCdnPolicy defaultTtl.

maxTtl

public maxTtl?: (number|null);

BackendBucketCdnPolicy maxTtl.

negativeCaching

public negativeCaching?: (boolean|null);

BackendBucketCdnPolicy negativeCaching.

negativeCachingPolicy

public negativeCachingPolicy: google.cloud.compute.v1.IBackendBucketCdnPolicyNegativeCachingPolicy[];

BackendBucketCdnPolicy negativeCachingPolicy.

requestCoalescing

public requestCoalescing?: (boolean|null);

BackendBucketCdnPolicy requestCoalescing.

serveWhileStale

public serveWhileStale?: (number|null);

BackendBucketCdnPolicy serveWhileStale.

signedUrlCacheMaxAgeSec

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

BackendBucketCdnPolicy signedUrlCacheMaxAgeSec.

signedUrlKeyNames

public signedUrlKeyNames: string[];

BackendBucketCdnPolicy signedUrlKeyNames.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IBackendBucketCdnPolicy): google.cloud.compute.v1.BackendBucketCdnPolicy;

Creates a new BackendBucketCdnPolicy instance using the specified properties.

Parameter
Name Description
properties IBackendBucketCdnPolicy

Properties to set

Returns
Type Description
BackendBucketCdnPolicy

BackendBucketCdnPolicy instance

decode(reader, length)

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

Decodes a BackendBucketCdnPolicy 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
BackendBucketCdnPolicy

BackendBucketCdnPolicy

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
BackendBucketCdnPolicy

BackendBucketCdnPolicy

encode(message, writer)

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

Encodes the specified BackendBucketCdnPolicy message. Does not implicitly messages.

Parameters
Name Description
message IBackendBucketCdnPolicy

BackendBucketCdnPolicy 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.cloud.compute.v1.IBackendBucketCdnPolicy, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IBackendBucketCdnPolicy

BackendBucketCdnPolicy 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.cloud.compute.v1.BackendBucketCdnPolicy;

Creates a BackendBucketCdnPolicy 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
BackendBucketCdnPolicy

BackendBucketCdnPolicy

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for BackendBucketCdnPolicy

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 BackendBucketCdnPolicy to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message BackendBucketCdnPolicy

BackendBucketCdnPolicy

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 BackendBucketCdnPolicy message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not