Class protos.google.cloud.compute.v1.HttpRedirectAction (4.5.0)

Represents a HttpRedirectAction.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new HttpRedirectAction.

Parameter
Name Description
properties IHttpRedirectAction

Properties to set

Properties

_hostRedirect

public _hostRedirect?: "hostRedirect";

HttpRedirectAction _hostRedirect.

_httpsRedirect

public _httpsRedirect?: "httpsRedirect";

HttpRedirectAction _httpsRedirect.

_pathRedirect

public _pathRedirect?: "pathRedirect";

HttpRedirectAction _pathRedirect.

_prefixRedirect

public _prefixRedirect?: "prefixRedirect";

HttpRedirectAction _prefixRedirect.

_redirectResponseCode

public _redirectResponseCode?: "redirectResponseCode";

HttpRedirectAction _redirectResponseCode.

_stripQuery

public _stripQuery?: "stripQuery";

HttpRedirectAction _stripQuery.

hostRedirect

public hostRedirect?: (string|null);

HttpRedirectAction hostRedirect.

httpsRedirect

public httpsRedirect?: (boolean|null);

HttpRedirectAction httpsRedirect.

pathRedirect

public pathRedirect?: (string|null);

HttpRedirectAction pathRedirect.

prefixRedirect

public prefixRedirect?: (string|null);

HttpRedirectAction prefixRedirect.

redirectResponseCode

public redirectResponseCode?: (string|null);

HttpRedirectAction redirectResponseCode.

stripQuery

public stripQuery?: (boolean|null);

HttpRedirectAction stripQuery.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IHttpRedirectAction): google.cloud.compute.v1.HttpRedirectAction;

Creates a new HttpRedirectAction instance using the specified properties.

Parameter
Name Description
properties IHttpRedirectAction

Properties to set

Returns
Type Description
HttpRedirectAction

HttpRedirectAction instance

decode(reader, length)

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

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

HttpRedirectAction

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
HttpRedirectAction

HttpRedirectAction

encode(message, writer)

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

Encodes the specified HttpRedirectAction message. Does not implicitly messages.

Parameters
Name Description
message IHttpRedirectAction

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

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

Parameters
Name Description
message IHttpRedirectAction

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

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

HttpRedirectAction

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for HttpRedirectAction

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message HttpRedirectAction

HttpRedirectAction

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