Class protos.google.cloud.networkservices.v1.GrpcRoute.RouteAction (0.2.1)

Represents a RouteAction.

Package

@google-cloud/networkservices

Constructors

(constructor)(properties)

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

Constructs a new RouteAction.

Parameter
Name Description
properties IRouteAction

Properties to set

Properties

destinations

public destinations: google.cloud.networkservices.v1.GrpcRoute.IDestination[];

RouteAction destinations.

faultInjectionPolicy

public faultInjectionPolicy?: (google.cloud.networkservices.v1.GrpcRoute.IFaultInjectionPolicy|null);

RouteAction faultInjectionPolicy.

retryPolicy

public retryPolicy?: (google.cloud.networkservices.v1.GrpcRoute.IRetryPolicy|null);

RouteAction retryPolicy.

timeout

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

RouteAction timeout.

Methods

create(properties)

public static create(properties?: google.cloud.networkservices.v1.GrpcRoute.IRouteAction): google.cloud.networkservices.v1.GrpcRoute.RouteAction;

Creates a new RouteAction instance using the specified properties.

Parameter
Name Description
properties IRouteAction

Properties to set

Returns
Type Description
RouteAction

RouteAction instance

decode(reader, length)

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

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

RouteAction

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
RouteAction

RouteAction

encode(message, writer)

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

Encodes the specified RouteAction message. Does not implicitly messages.

Parameters
Name Description
message IRouteAction

RouteAction 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.GrpcRoute.IRouteAction, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IRouteAction

RouteAction 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.GrpcRoute.RouteAction;

Creates a RouteAction 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
RouteAction

RouteAction

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for RouteAction

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message RouteAction

RouteAction

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