Class HttpTarget (2.45.0) 

public final class HttpTarget extends GeneratedMessageV3 implements HttpTargetOrBuilder

Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered.

Protobuf type google.cloud.scheduler.v1beta1.HttpTarget

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > HttpTarget

Implements

HttpTargetOrBuilder

Static Fields

BODY_FIELD_NUMBER

public static final int BODY_FIELD_NUMBER
Field Value
Type Description
int

HEADERS_FIELD_NUMBER

public static final int HEADERS_FIELD_NUMBER
Field Value
Type Description
int

HTTP_METHOD_FIELD_NUMBER

public static final int HTTP_METHOD_FIELD_NUMBER
Field Value
Type Description
int

OAUTH_TOKEN_FIELD_NUMBER

public static final int OAUTH_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

OIDC_TOKEN_FIELD_NUMBER

public static final int OIDC_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static HttpTarget getDefaultInstance()
Returns
Type Description
HttpTarget

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static HttpTarget.Builder newBuilder()
Returns
Type Description
HttpTarget.Builder

newBuilder(HttpTarget prototype)

public static HttpTarget.Builder newBuilder(HttpTarget prototype)
Parameter
Name Description
prototype HttpTarget
Returns
Type Description
HttpTarget.Builder

parseDelimitedFrom(InputStream input)

public static HttpTarget parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HttpTarget
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpTarget parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpTarget
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static HttpTarget parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
HttpTarget
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static HttpTarget parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpTarget
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static HttpTarget parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
HttpTarget
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static HttpTarget parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpTarget
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static HttpTarget parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
HttpTarget
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpTarget parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpTarget
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static HttpTarget parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HttpTarget
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpTarget parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpTarget
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static HttpTarget parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
HttpTarget
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static HttpTarget parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpTarget
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<HttpTarget> parser()
Returns
Type Description
Parser<HttpTarget>

Methods

containsHeaders(String key)

public boolean containsHeaders(String key)

The user can specify HTTP request headers to send with the job's HTTP request. This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. These headers represent a subset of the headers that will accompany the job's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is below:

  • Host: This will be computed by Cloud Scheduler and derived from uri.
  • Content-Length: This will be computed by Cloud Scheduler.
  • User-Agent: This will be set to "Google-Cloud-Scheduler".
  • X-Google-*: Google internal use only.
  • X-AppEngine-*: Google internal use only.
  • X-CloudScheduler: This header will be set to true.
  • X-CloudScheduler-JobName: This header will contain the job name.

  • X-CloudScheduler-ScheduleTime: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339.

    The total size of headers must be less than 80KB.

map<string, string> headers = 3;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAuthorizationHeaderCase()

public HttpTarget.AuthorizationHeaderCase getAuthorizationHeaderCase()
Returns
Type Description
HttpTarget.AuthorizationHeaderCase

getBody()

public ByteString getBody()

HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.

bytes body = 4;

Returns
Type Description
ByteString

The body.

getDefaultInstanceForType()

public HttpTarget getDefaultInstanceForType()
Returns
Type Description
HttpTarget

getHeaders() (deprecated)

public Map<String,String> getHeaders()

Use #getHeadersMap() instead.

Returns
Type Description
Map<String,String>

getHeadersCount()

public int getHeadersCount()

The user can specify HTTP request headers to send with the job's HTTP request. This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. These headers represent a subset of the headers that will accompany the job's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is below:

  • Host: This will be computed by Cloud Scheduler and derived from uri.
  • Content-Length: This will be computed by Cloud Scheduler.
  • User-Agent: This will be set to "Google-Cloud-Scheduler".
  • X-Google-*: Google internal use only.
  • X-AppEngine-*: Google internal use only.
  • X-CloudScheduler: This header will be set to true.
  • X-CloudScheduler-JobName: This header will contain the job name.

  • X-CloudScheduler-ScheduleTime: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339.

    The total size of headers must be less than 80KB.

map<string, string> headers = 3;

Returns
Type Description
int

getHeadersMap()

public Map<String,String> getHeadersMap()

The user can specify HTTP request headers to send with the job's HTTP request. This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. These headers represent a subset of the headers that will accompany the job's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is below:

  • Host: This will be computed by Cloud Scheduler and derived from uri.
  • Content-Length: This will be computed by Cloud Scheduler.
  • User-Agent: This will be set to "Google-Cloud-Scheduler".
  • X-Google-*: Google internal use only.
  • X-AppEngine-*: Google internal use only.
  • X-CloudScheduler: This header will be set to true.
  • X-CloudScheduler-JobName: This header will contain the job name.

  • X-CloudScheduler-ScheduleTime: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339.

    The total size of headers must be less than 80KB.

map<string, string> headers = 3;

Returns
Type Description
Map<String,String>

getHeadersOrDefault(String key, String defaultValue)

public String getHeadersOrDefault(String key, String defaultValue)

The user can specify HTTP request headers to send with the job's HTTP request. This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. These headers represent a subset of the headers that will accompany the job's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is below:

  • Host: This will be computed by Cloud Scheduler and derived from uri.
  • Content-Length: This will be computed by Cloud Scheduler.
  • User-Agent: This will be set to "Google-Cloud-Scheduler".
  • X-Google-*: Google internal use only.
  • X-AppEngine-*: Google internal use only.
  • X-CloudScheduler: This header will be set to true.
  • X-CloudScheduler-JobName: This header will contain the job name.

  • X-CloudScheduler-ScheduleTime: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339.

    The total size of headers must be less than 80KB.

map<string, string> headers = 3;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getHeadersOrThrow(String key)

public String getHeadersOrThrow(String key)

The user can specify HTTP request headers to send with the job's HTTP request. This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. These headers represent a subset of the headers that will accompany the job's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is below:

  • Host: This will be computed by Cloud Scheduler and derived from uri.
  • Content-Length: This will be computed by Cloud Scheduler.
  • User-Agent: This will be set to "Google-Cloud-Scheduler".
  • X-Google-*: Google internal use only.
  • X-AppEngine-*: Google internal use only.
  • X-CloudScheduler: This header will be set to true.
  • X-CloudScheduler-JobName: This header will contain the job name.

  • X-CloudScheduler-ScheduleTime: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339.

    The total size of headers must be less than 80KB.

map<string, string> headers = 3;

Parameter
Name Description
key String
Returns
Type Description
String

getHttpMethod()

public HttpMethod getHttpMethod()

Which HTTP method to use for the request.

.google.cloud.scheduler.v1beta1.HttpMethod http_method = 2;

Returns
Type Description
HttpMethod

The httpMethod.

getHttpMethodValue()

public int getHttpMethodValue()

Which HTTP method to use for the request.

.google.cloud.scheduler.v1beta1.HttpMethod http_method = 2;

Returns
Type Description
int

The enum numeric value on the wire for httpMethod.

getOauthToken()

public OAuthToken getOauthToken()

If specified, an OAuth token will be generated and attached as an Authorization header in the HTTP request.

This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.

.google.cloud.scheduler.v1beta1.OAuthToken oauth_token = 5;

Returns
Type Description
OAuthToken

The oauthToken.

getOauthTokenOrBuilder()

public OAuthTokenOrBuilder getOauthTokenOrBuilder()

If specified, an OAuth token will be generated and attached as an Authorization header in the HTTP request.

This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.

.google.cloud.scheduler.v1beta1.OAuthToken oauth_token = 5;

Returns
Type Description
OAuthTokenOrBuilder

getOidcToken()

public OidcToken getOidcToken()

If specified, an OIDC token will be generated and attached as an Authorization header in the HTTP request.

This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.

.google.cloud.scheduler.v1beta1.OidcToken oidc_token = 6;

Returns
Type Description
OidcToken

The oidcToken.

getOidcTokenOrBuilder()

public OidcTokenOrBuilder getOidcTokenOrBuilder()

If specified, an OIDC token will be generated and attached as an Authorization header in the HTTP request.

This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.

.google.cloud.scheduler.v1beta1.OidcToken oidc_token = 6;

Returns
Type Description
OidcTokenOrBuilder

getParserForType()

public Parser<HttpTarget> getParserForType()
Returns
Type Description
Parser<HttpTarget>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUri()

public String getUri()

Required. The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are: http://acme.com and https://acme.com/sales:8080. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.

string uri = 1;

Returns
Type Description
String

The uri.

getUriBytes()

public ByteString getUriBytes()

Required. The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are: http://acme.com and https://acme.com/sales:8080. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.

string uri = 1;

Returns
Type Description
ByteString

The bytes for uri.

hasOauthToken()

public boolean hasOauthToken()

If specified, an OAuth token will be generated and attached as an Authorization header in the HTTP request.

This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.

.google.cloud.scheduler.v1beta1.OAuthToken oauth_token = 5;

Returns
Type Description
boolean

Whether the oauthToken field is set.

hasOidcToken()

public boolean hasOidcToken()

If specified, an OIDC token will be generated and attached as an Authorization header in the HTTP request.

This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.

.google.cloud.scheduler.v1beta1.OidcToken oidc_token = 6;

Returns
Type Description
boolean

Whether the oidcToken field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public HttpTarget.Builder newBuilderForType()
Returns
Type Description
HttpTarget.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected HttpTarget.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
HttpTarget.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public HttpTarget.Builder toBuilder()
Returns
Type Description
HttpTarget.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException