Class protos.google.cloud.compute.v1.CacheKeyPolicy (3.0.0)

Represents a CacheKeyPolicy.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new CacheKeyPolicy.

Parameter
Name Description
properties ICacheKeyPolicy

Properties to set

Properties

_includeHost

public _includeHost?: "includeHost";

CacheKeyPolicy _includeHost.

_includeProtocol

public _includeProtocol?: "includeProtocol";

CacheKeyPolicy _includeProtocol.

_includeQueryString

public _includeQueryString?: "includeQueryString";

CacheKeyPolicy _includeQueryString.

includeHost

public includeHost?: (boolean|null);

CacheKeyPolicy includeHost.

includeProtocol

public includeProtocol?: (boolean|null);

CacheKeyPolicy includeProtocol.

includeQueryString

public includeQueryString?: (boolean|null);

CacheKeyPolicy includeQueryString.

queryStringBlacklist

public queryStringBlacklist: string[];

CacheKeyPolicy queryStringBlacklist.

queryStringWhitelist

public queryStringWhitelist: string[];

CacheKeyPolicy queryStringWhitelist.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.ICacheKeyPolicy): google.cloud.compute.v1.CacheKeyPolicy;

Creates a new CacheKeyPolicy instance using the specified properties.

Parameter
Name Description
properties ICacheKeyPolicy

Properties to set
Returns
Type Description
google.cloud.compute.v1.CacheKeyPolicy

CacheKeyPolicy instance

decode(reader, length)

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

Decodes a CacheKeyPolicy message from the specified reader or buffer.

Parameters
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
google.cloud.compute.v1.CacheKeyPolicy

CacheKeyPolicy

decodeDelimited(reader)

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

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

Parameter
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
google.cloud.compute.v1.CacheKeyPolicy

CacheKeyPolicy

encode(message, writer)

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

Encodes the specified CacheKeyPolicy message. Does not implicitly messages.

Parameters
Name Description
message ICacheKeyPolicy

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

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

Parameters
Name Description
message ICacheKeyPolicy

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

Creates a CacheKeyPolicy 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
google.cloud.compute.v1.CacheKeyPolicy

CacheKeyPolicy

toJSON()

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

Converts this CacheKeyPolicy to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.cloud.compute.v1.CacheKeyPolicy

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