Class protos.google.cloud.networkservices.v1.AuthzExtension (0.12.0)

Represents an AuthzExtension.

Package

@google-cloud/networkservices

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.networkservices.v1.IAuthzExtension);

Constructs a new AuthzExtension.

Parameter
Name Description
properties IAuthzExtension

Properties to set

Properties

authority

public authority: string;

AuthzExtension authority.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

AuthzExtension createTime.

description

public description: string;

AuthzExtension description.

failOpen

public failOpen: boolean;

AuthzExtension failOpen.

forwardHeaders

public forwardHeaders: string[];

AuthzExtension forwardHeaders.

labels

public labels: { [k: string]: string };

AuthzExtension labels.

loadBalancingScheme

public loadBalancingScheme: (google.cloud.networkservices.v1.LoadBalancingScheme|keyof typeof google.cloud.networkservices.v1.LoadBalancingScheme);

AuthzExtension loadBalancingScheme.

metadata

public metadata?: (google.protobuf.IStruct|null);

AuthzExtension metadata.

name

public name: string;

AuthzExtension name.

service

public service: string;

AuthzExtension service.

timeout

public timeout?: (google.protobuf.IDuration|null);

AuthzExtension timeout.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

AuthzExtension updateTime.

wireFormat

public wireFormat: (google.cloud.networkservices.v1.WireFormat|keyof typeof google.cloud.networkservices.v1.WireFormat);

AuthzExtension wireFormat.

Methods

create(properties)

public static create(properties?: google.cloud.networkservices.v1.IAuthzExtension): google.cloud.networkservices.v1.AuthzExtension;

Creates a new AuthzExtension instance using the specified properties.

Parameter
Name Description
properties IAuthzExtension

Properties to set

Returns
Type Description
AuthzExtension

AuthzExtension instance

decode(reader, length)

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

Decodes an AuthzExtension 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
AuthzExtension

AuthzExtension

decodeDelimited(reader)

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

Decodes an AuthzExtension message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
AuthzExtension

AuthzExtension

encode(message, writer)

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

Encodes the specified AuthzExtension message. Does not implicitly messages.

Parameters
Name Description
message IAuthzExtension

AuthzExtension 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.networkservices.v1.IAuthzExtension, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IAuthzExtension

AuthzExtension 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.networkservices.v1.AuthzExtension;

Creates an AuthzExtension 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
AuthzExtension

AuthzExtension

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AuthzExtension

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message AuthzExtension

AuthzExtension

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 an AuthzExtension 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