Class google.cloud.scheduler.v1.AppEngineHttpTarget (2.1.1)

Represents an AppEngineHttpTarget.

Package

@google-cloud/scheduler!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.scheduler.v1.IAppEngineHttpTarget);

Constructs a new AppEngineHttpTarget.

Parameter

Name	Description
properties	`IAppEngineHttpTarget` Properties to set

Properties

appEngineRouting

public appEngineRouting?: (google.cloud.scheduler.v1.IAppEngineRouting|null);

AppEngineHttpTarget appEngineRouting.

Property Value

Type	Description
(google.cloud.scheduler.v1.IAppEngineRouting\|null)

body

public body: (Uint8Array|string);

AppEngineHttpTarget body.

Property Value

Type	Description
(Uint8Array\|string)

headers

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

AppEngineHttpTarget headers.

Property Value

Type	Description
{ [k: string]: string }

httpMethod

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

AppEngineHttpTarget httpMethod.

Property Value

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

relativeUri

public relativeUri: string;

AppEngineHttpTarget relativeUri.

Property Value

Type	Description
string

Methods

create(properties)

public static create(properties?: google.cloud.scheduler.v1.IAppEngineHttpTarget): google.cloud.scheduler.v1.AppEngineHttpTarget;

Creates a new AppEngineHttpTarget instance using the specified properties.

Parameter

Name	Description
properties	`IAppEngineHttpTarget` Properties to set

Returns

Type	Description
AppEngineHttpTarget	AppEngineHttpTarget instance

decode(reader, length)

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

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

decodeDelimited(reader)

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

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

encode(message, writer)

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

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

Parameters

Name	Description
message	`IAppEngineHttpTarget` AppEngineHttpTarget 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.v1.IAppEngineHttpTarget, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IAppEngineHttpTarget` AppEngineHttpTarget 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.v1.AppEngineHttpTarget;

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

toJSON()

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

Converts this AppEngineHttpTarget to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`AppEngineHttpTarget` AppEngineHttpTarget
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 AppEngineHttpTarget 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