Class google.cloud.scheduler.v1beta1.HttpTarget (2.1.1)

Version 2.1.1

• 3.3.1 (latest)
• 3.2.1
• 3.0.5
• 2.3.0
• 2.2.6
• 2.1.1

Represents a HttpTarget.

Package

@google-cloud/scheduler!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.scheduler.v1beta1.IHttpTarget);

Constructs a new HttpTarget.

Parameter

Name	Description
properties	IHttpTarget Properties to set

Properties

authorizationHeader

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

HttpTarget authorizationHeader.

Property Value

Type	Description
("oauthToken"|"oidcToken")

body

public body: (Uint8Array|string);

HttpTarget body.

Property Value

Type	Description
(Uint8Array|string)

headers

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

HttpTarget headers.

Property Value

Type	Description
{ [k: string]: string }

httpMethod

public httpMethod: (google.cloud.scheduler.v1beta1.HttpMethod|keyof typeof google.cloud.scheduler.v1beta1.HttpMethod);

HttpTarget httpMethod.

Property Value

Type	Description
(google.cloud.scheduler.v1beta1.HttpMethod|keyof typeof google.cloud.scheduler.v1beta1.HttpMethod)

oauthToken

public oauthToken?: (google.cloud.scheduler.v1beta1.IOAuthToken|null);

HttpTarget oauthToken.

Property Value

Type	Description
(google.cloud.scheduler.v1beta1.IOAuthToken|null)

oidcToken

public oidcToken?: (google.cloud.scheduler.v1beta1.IOidcToken|null);

HttpTarget oidcToken.

Property Value

Type	Description
(google.cloud.scheduler.v1beta1.IOidcToken|null)

uri

public uri: string;

HttpTarget uri.

Property Value

Type	Description
string

Methods

create(properties)

public static create(properties?: google.cloud.scheduler.v1beta1.IHttpTarget): google.cloud.scheduler.v1beta1.HttpTarget;

Creates a new HttpTarget instance using the specified properties.

Parameter

Name	Description
properties	IHttpTarget Properties to set

Returns

Type	Description
HttpTarget	HttpTarget instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.scheduler.v1beta1.HttpTarget;

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

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.scheduler.v1beta1.HttpTarget;

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

encode(message, writer)

public static encode(message: google.cloud.scheduler.v1beta1.IHttpTarget, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified HttpTarget message. Does not implicitly verify messages.

Parameters

Name	Description
message	IHttpTarget HttpTarget 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.scheduler.v1beta1.IHttpTarget, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	IHttpTarget HttpTarget 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.scheduler.v1beta1.HttpTarget;

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

toJSON()

public toJSON(): { [k: string]: any };

Converts this HttpTarget to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	HttpTarget HttpTarget
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 HttpTarget 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