Class protos.google.cloud.networkservices.v1.EndpointPolicy (0.2.1)

Represents an EndpointPolicy.

Package

@google-cloud/networkservices

Constructors

(constructor)(properties)

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

Constructs a new EndpointPolicy.

Parameter
NameDescription
properties IEndpointPolicy

Properties to set

Properties

authorizationPolicy

public authorizationPolicy: string;

EndpointPolicy authorizationPolicy.

clientTlsPolicy

public clientTlsPolicy: string;

EndpointPolicy clientTlsPolicy.

createTime

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

EndpointPolicy createTime.

description

public description: string;

EndpointPolicy description.

endpointMatcher

public endpointMatcher?: (google.cloud.networkservices.v1.IEndpointMatcher|null);

EndpointPolicy endpointMatcher.

labels

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

EndpointPolicy labels.

name

public name: string;

EndpointPolicy name.

serverTlsPolicy

public serverTlsPolicy: string;

EndpointPolicy serverTlsPolicy.

trafficPortSelector

public trafficPortSelector?: (google.cloud.networkservices.v1.ITrafficPortSelector|null);

EndpointPolicy trafficPortSelector.

type

public type: (google.cloud.networkservices.v1.EndpointPolicy.EndpointPolicyType|keyof typeof google.cloud.networkservices.v1.EndpointPolicy.EndpointPolicyType);

EndpointPolicy type.

updateTime

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

EndpointPolicy updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.networkservices.v1.IEndpointPolicy): google.cloud.networkservices.v1.EndpointPolicy;

Creates a new EndpointPolicy instance using the specified properties.

Parameter
NameDescription
properties IEndpointPolicy

Properties to set

Returns
TypeDescription
EndpointPolicy

EndpointPolicy instance

decode(reader, length)

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

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

EndpointPolicy

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
EndpointPolicy

EndpointPolicy

encode(message, writer)

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

Encodes the specified EndpointPolicy message. Does not implicitly messages.

Parameters
NameDescription
message IEndpointPolicy

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

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

Parameters
NameDescription
message IEndpointPolicy

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

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

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

Plain object

Returns
TypeDescription
EndpointPolicy

EndpointPolicy

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for EndpointPolicy

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message EndpointPolicy

EndpointPolicy

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an EndpointPolicy 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