Class protos.google.cloud.tasks.v2beta2.UriOverride (5.5.2)

Represents an UriOverride.

Package

@google-cloud/tasks

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.tasks.v2beta2.IUriOverride);

Constructs a new UriOverride.

Parameter
Name Description
properties IUriOverride

Properties to set

Properties

host

public host?: (string|null);

UriOverride host.

pathOverride

public pathOverride?: (google.cloud.tasks.v2beta2.IPathOverride|null);

UriOverride pathOverride.

port

public port?: (number|Long|string|null);

UriOverride port.

queryOverride

public queryOverride?: (google.cloud.tasks.v2beta2.IQueryOverride|null);

UriOverride queryOverride.

scheme

public scheme?: (google.cloud.tasks.v2beta2.UriOverride.Scheme|keyof typeof google.cloud.tasks.v2beta2.UriOverride.Scheme|null);

UriOverride scheme.

uriOverrideEnforceMode

public uriOverrideEnforceMode: (google.cloud.tasks.v2beta2.UriOverride.UriOverrideEnforceMode|keyof typeof google.cloud.tasks.v2beta2.UriOverride.UriOverrideEnforceMode);

UriOverride uriOverrideEnforceMode.

Methods

create(properties)

public static create(properties?: google.cloud.tasks.v2beta2.IUriOverride): google.cloud.tasks.v2beta2.UriOverride;

Creates a new UriOverride instance using the specified properties.

Parameter
Name Description
properties IUriOverride

Properties to set

Returns
Type Description
UriOverride

UriOverride instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.tasks.v2beta2.UriOverride;

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

UriOverride

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.tasks.v2beta2.UriOverride;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
UriOverride

UriOverride

encode(message, writer)

public static encode(message: google.cloud.tasks.v2beta2.IUriOverride, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified UriOverride message. Does not implicitly messages.

Parameters
Name Description
message IUriOverride

UriOverride 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.tasks.v2beta2.IUriOverride, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IUriOverride

UriOverride 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.tasks.v2beta2.UriOverride;

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

UriOverride

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for UriOverride

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message UriOverride

UriOverride

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