Class protos.google.cloud.tasks.v2.HttpRequest (3.0.5)

Represents a HttpRequest.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.tasks.v2.IHttpRequest);

Constructs a new HttpRequest.

Parameter

Name	Description
properties	`IHttpRequest` Properties to set

Properties

authorizationHeader

public authorizationHeader?: ("oauthToken"|"oidcToken");

HttpRequest authorizationHeader.

body

public body: (Uint8Array|string);

HttpRequest body.

headers

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

HttpRequest headers.

httpMethod

public httpMethod: (google.cloud.tasks.v2.HttpMethod|keyof typeof google.cloud.tasks.v2.HttpMethod);

HttpRequest httpMethod.

oauthToken

public oauthToken?: (google.cloud.tasks.v2.IOAuthToken|null);

HttpRequest oauthToken.

oidcToken

public oidcToken?: (google.cloud.tasks.v2.IOidcToken|null);

HttpRequest oidcToken.

url

public url: string;

HttpRequest url.

Methods

create(properties)

public static create(properties?: google.cloud.tasks.v2.IHttpRequest): google.cloud.tasks.v2.HttpRequest;

Creates a new HttpRequest instance using the specified properties.

Parameter

Name	Description
properties	`IHttpRequest` Properties to set

Returns

Type	Description
google.cloud.tasks.v2.HttpRequest	HttpRequest instance

decode(reader, length)

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

Decodes a HttpRequest message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.tasks.v2.HttpRequest	HttpRequest

decodeDelimited(reader)

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

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

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.tasks.v2.HttpRequest	HttpRequest

encode(message, writer)

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

Encodes the specified HttpRequest message. Does not implicitly messages.

Parameters

Name	Description
message	`IHttpRequest` HttpRequest 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.v2.IHttpRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IHttpRequest` HttpRequest 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.v2.HttpRequest;

Creates a HttpRequest 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
google.cloud.tasks.v2.HttpRequest	HttpRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for HttpRequest

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

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.tasks.v2.HttpRequest` HttpRequest
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 HttpRequest 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