Represents a HttpTarget.
Package
@google-cloud/scheduler!Constructors
(constructor)(properties)
constructor
(
properties
?:
google
.
cloud
.
scheduler
.
v1
.
IHttpTarget
);
Constructs a new HttpTarget.
| Name | Description |
| properties | IHttpTarget
Properties to set |
Properties
authorizationHeader
public
authorizationHeader
?:
(
"oauthToken"
|
"oidcToken"
);
HttpTarget authorizationHeader.
| Type | Description |
|---|---|
| ("oauthToken"|"oidcToken") |
body
public
body
:
(
Uint8Array
|
string
);
HttpTarget body.
| Type | Description |
|---|---|
| ( Uint8Array |string) |
headers
public
headers
:
{
[
k
:
string
]
:
string
};
HttpTarget headers.
| Type | Description |
|---|---|
| { [k: string]: string } |
httpMethod
public
httpMethod
:
(
google
.
cloud
.
scheduler
.
v1
.
HttpMethod
|
keyof
typeof
google
.
cloud
.
scheduler
.
v1
.
HttpMethod
);
HttpTarget httpMethod.
| Type | Description |
|---|---|
| ( google.cloud.scheduler.v1.HttpMethod |keyof typeof google.cloud.scheduler.v1.HttpMethod ) |
oauthToken
public
oauthToken
?:
(
google
.
cloud
.
scheduler
.
v1
.
IOAuthToken
|
null
);
HttpTarget oauthToken.
| Type | Description |
|---|---|
| ( google.cloud.scheduler.v1.IOAuthToken |null) |
oidcToken
public
oidcToken
?:
(
google
.
cloud
.
scheduler
.
v1
.
IOidcToken
|
null
);
HttpTarget oidcToken.
| Type | Description |
|---|---|
| ( google.cloud.scheduler.v1.IOidcToken |null) |
uri
public
uri
:
string
;
HttpTarget uri.
| Type | Description |
|---|---|
| string |
Methods
create(properties)
public
static
create
(
properties
?:
google
.
cloud
.
scheduler
.
v1
.
IHttpTarget
)
:
google
.
cloud
.
scheduler
.
v1
.
HttpTarget
;
Creates a new HttpTarget instance using the specified properties.
| Name | Description |
| properties | IHttpTarget
Properties to set |
| Type | Description |
|---|---|
| HttpTarget | HttpTarget instance |
decode(reader, length)
public
static
decode
(
reader
:
(
$protobuf
.
Reader
|
Uint8Array
),
length
?:
number
)
:
google
.
cloud
.
scheduler
.
v1
.
HttpTarget
;
Decodes a HttpTarget message from the specified reader or buffer.
| Name | Description |
| reader | ($protobuf. Reader
| Uint8Array
)
Reader or buffer to decode from |
| length | number
Message length if known beforehand |
| Type | Description |
|---|---|
| HttpTarget | HttpTarget |
decodeDelimited(reader)
public
static
decodeDelimited
(
reader
:
(
$protobuf
.
Reader
|
Uint8Array
))
:
google
.
cloud
.
scheduler
.
v1
.
HttpTarget
;
Decodes a HttpTarget message from the specified reader or buffer, length delimited.
| Name | Description |
| reader | ($protobuf. Reader
| Uint8Array
)
Reader or buffer to decode from |
| Type | Description |
|---|---|
| HttpTarget | HttpTarget |
encode(message, writer)
public
static
encode
(
message
:
google
.
cloud
.
scheduler
.
v1
.
IHttpTarget
,
writer
?:
$protobuf
.
Writer
)
:
$protobuf
.
Writer
;
Encodes the specified HttpTarget message. Does not implicitly verify messages.
| Name | Description |
| message | IHttpTarget
HttpTarget message or plain object to encode |
| writer | $protobuf. Writer
Writer to encode to |
| Type | Description |
|---|---|
| $protobuf. Writer | Writer |
encodeDelimited(message, writer)
public
static
encodeDelimited
(
message
:
google
.
cloud
.
scheduler
.
v1
.
IHttpTarget
,
writer
?:
$protobuf
.
Writer
)
:
$protobuf
.
Writer
;
Encodes the specified HttpTarget message, length delimited. Does not implicitly verify messages.
| Name | Description |
| message | IHttpTarget
HttpTarget message or plain object to encode |
| writer | $protobuf. Writer
Writer to encode to |
| Type | Description |
|---|---|
| $protobuf. Writer | Writer |
fromObject(object)
public
static
fromObject
(
object
:
{
[
k
:
string
]
:
any
})
:
google
.
cloud
.
scheduler
.
v1
.
HttpTarget
;
Creates a HttpTarget message from a plain object. Also converts values to their respective internal types.
| Name | Description |
| object | { [k: string]: any }
Plain object |
| Type | Description |
|---|---|
| HttpTarget | HttpTarget |
toJSON()
public
toJSON
()
:
{
[
k
:
string
]
:
any
};
Converts this HttpTarget to JSON.
| Type | Description |
|---|---|
| { [k: string]: any } | JSON object |
toObject(message, options)
public
static
toObject
(
message
:
google
.
cloud
.
scheduler
.
v1
.
HttpTarget
,
options
?:
$protobuf
.
IConversionOptions
)
:
{
[
k
:
string
]
:
any
};
Creates a plain object from a HttpTarget message. Also converts values to other types if specified.
| Name | Description |
| message | HttpTarget
HttpTarget |
| options | $protobuf. IConversionOptions
Conversion options |
| Type | Description |
|---|---|
| { [k: string]: any } | Plain object |
verify(message)
public
static
verify
(
message
:
{
[
k
:
string
]
:
any
})
:
(
string
|
null
);
Verifies a HttpTarget message.
| Name | Description |
| message | { [k: string]: any }
Plain object to verify |
| Type | Description |
| (string|null) | |
