Class protos.google.cloud.compute.v1.CorsPolicy (3.9.1)

Represents a CorsPolicy.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new CorsPolicy.

Parameter
NameDescription
properties ICorsPolicy

Properties to set

Properties

_allowCredentials

public _allowCredentials?: "allowCredentials";

CorsPolicy _allowCredentials.

_disabled

public _disabled?: "disabled";

CorsPolicy _disabled.

_maxAge

public _maxAge?: "maxAge";

CorsPolicy _maxAge.

allowCredentials

public allowCredentials?: (boolean|null);

CorsPolicy allowCredentials.

allowHeaders

public allowHeaders: string[];

CorsPolicy allowHeaders.

allowMethods

public allowMethods: string[];

CorsPolicy allowMethods.

allowOriginRegexes

public allowOriginRegexes: string[];

CorsPolicy allowOriginRegexes.

allowOrigins

public allowOrigins: string[];

CorsPolicy allowOrigins.

disabled

public disabled?: (boolean|null);

CorsPolicy disabled.

exposeHeaders

public exposeHeaders: string[];

CorsPolicy exposeHeaders.

maxAge

public maxAge?: (number|null);

CorsPolicy maxAge.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.ICorsPolicy): google.cloud.compute.v1.CorsPolicy;

Creates a new CorsPolicy instance using the specified properties.

Parameter
NameDescription
properties ICorsPolicy

Properties to set

Returns
TypeDescription
google.cloud.compute.v1.CorsPolicy

CorsPolicy instance

decode(reader, length)

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

Decodes a CorsPolicy message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.compute.v1.CorsPolicy

CorsPolicy

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.compute.v1.CorsPolicy

CorsPolicy

encode(message, writer)

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

Encodes the specified CorsPolicy message. Does not implicitly messages.

Parameters
NameDescription
message ICorsPolicy

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

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

Parameters
NameDescription
message ICorsPolicy

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

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

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

Plain object

Returns
TypeDescription
google.cloud.compute.v1.CorsPolicy

CorsPolicy

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CorsPolicy

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.compute.v1.CorsPolicy

CorsPolicy

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