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
NameDescription
properties IAppEngineHttpTarget

Properties to set

Properties

appEngineRouting

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

AppEngineHttpTarget appEngineRouting.

Property Value
TypeDescription
(google.cloud.scheduler.v1.IAppEngineRouting|null)

body

public body: (Uint8Array|string);

AppEngineHttpTarget body.

Property Value
TypeDescription
(Uint8Array|string)

headers

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

AppEngineHttpTarget headers.

Property Value
TypeDescription
{ [k: string]: string }

httpMethod

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

AppEngineHttpTarget httpMethod.

Property Value
TypeDescription
(google.cloud.scheduler.v1.HttpMethod|keyof typeof google.cloud.scheduler.v1.HttpMethod)

relativeUri

public relativeUri: string;

AppEngineHttpTarget relativeUri.

Property Value
TypeDescription
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
NameDescription
properties IAppEngineHttpTarget

Properties to set

Returns
TypeDescription
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
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
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
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
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
NameDescription
message IAppEngineHttpTarget

AppEngineHttpTarget message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$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
NameDescription
message IAppEngineHttpTarget

AppEngineHttpTarget message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$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
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
AppEngineHttpTarget

AppEngineHttpTarget

toJSON()

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

Converts this AppEngineHttpTarget to JSON.

Returns
TypeDescription
{ [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
NameDescription
message AppEngineHttpTarget

AppEngineHttpTarget

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an AppEngineHttpTarget message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not