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

Represents a BackendServiceCdnPolicy.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new BackendServiceCdnPolicy.

Parameter
NameDescription
properties IBackendServiceCdnPolicy

Properties to set

Properties

_cacheKeyPolicy

public _cacheKeyPolicy?: "cacheKeyPolicy";

BackendServiceCdnPolicy _cacheKeyPolicy.

_cacheMode

public _cacheMode?: "cacheMode";

BackendServiceCdnPolicy _cacheMode.

_clientTtl

public _clientTtl?: "clientTtl";

BackendServiceCdnPolicy _clientTtl.

_defaultTtl

public _defaultTtl?: "defaultTtl";

BackendServiceCdnPolicy _defaultTtl.

_maxTtl

public _maxTtl?: "maxTtl";

BackendServiceCdnPolicy _maxTtl.

_negativeCaching

public _negativeCaching?: "negativeCaching";

BackendServiceCdnPolicy _negativeCaching.

_requestCoalescing

public _requestCoalescing?: "requestCoalescing";

BackendServiceCdnPolicy _requestCoalescing.

_serveWhileStale

public _serveWhileStale?: "serveWhileStale";

BackendServiceCdnPolicy _serveWhileStale.

_signedUrlCacheMaxAgeSec

public _signedUrlCacheMaxAgeSec?: "signedUrlCacheMaxAgeSec";

BackendServiceCdnPolicy _signedUrlCacheMaxAgeSec.

bypassCacheOnRequestHeaders

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

BackendServiceCdnPolicy bypassCacheOnRequestHeaders.

cacheKeyPolicy

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

BackendServiceCdnPolicy cacheKeyPolicy.

cacheMode

public cacheMode?: (string|null);

BackendServiceCdnPolicy cacheMode.

clientTtl

public clientTtl?: (number|null);

BackendServiceCdnPolicy clientTtl.

defaultTtl

public defaultTtl?: (number|null);

BackendServiceCdnPolicy defaultTtl.

maxTtl

public maxTtl?: (number|null);

BackendServiceCdnPolicy maxTtl.

negativeCaching

public negativeCaching?: (boolean|null);

BackendServiceCdnPolicy negativeCaching.

negativeCachingPolicy

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

BackendServiceCdnPolicy negativeCachingPolicy.

requestCoalescing

public requestCoalescing?: (boolean|null);

BackendServiceCdnPolicy requestCoalescing.

serveWhileStale

public serveWhileStale?: (number|null);

BackendServiceCdnPolicy serveWhileStale.

signedUrlCacheMaxAgeSec

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

BackendServiceCdnPolicy signedUrlCacheMaxAgeSec.

signedUrlKeyNames

public signedUrlKeyNames: string[];

BackendServiceCdnPolicy signedUrlKeyNames.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IBackendServiceCdnPolicy): google.cloud.compute.v1.BackendServiceCdnPolicy;

Creates a new BackendServiceCdnPolicy instance using the specified properties.

Parameter
NameDescription
properties IBackendServiceCdnPolicy

Properties to set

Returns
TypeDescription
BackendServiceCdnPolicy

BackendServiceCdnPolicy instance

decode(reader, length)

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

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

BackendServiceCdnPolicy

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
BackendServiceCdnPolicy

BackendServiceCdnPolicy

encode(message, writer)

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

Encodes the specified BackendServiceCdnPolicy message. Does not implicitly messages.

Parameters
NameDescription
message IBackendServiceCdnPolicy

BackendServiceCdnPolicy 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.IBackendServiceCdnPolicy, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IBackendServiceCdnPolicy

BackendServiceCdnPolicy 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.BackendServiceCdnPolicy;

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

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

Plain object

Returns
TypeDescription
BackendServiceCdnPolicy

BackendServiceCdnPolicy

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for BackendServiceCdnPolicy

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message BackendServiceCdnPolicy

BackendServiceCdnPolicy

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 BackendServiceCdnPolicy 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