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.events.cloud.scheduler.v1.HttpTarget
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
BODY_FIELD_NUMBER
public static final int BODY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static HttpTarget.Builder newBuilder()
newBuilder(HttpTarget prototype)
public static HttpTarget.Builder newBuilder(HttpTarget prototype)
public static HttpTarget parseDelimitedFrom(InputStream input)
public static HttpTarget parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static HttpTarget parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static HttpTarget parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static HttpTarget parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static HttpTarget parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static HttpTarget parseFrom(CodedInputStream input)
public static HttpTarget parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static HttpTarget parseFrom(InputStream input)
public static HttpTarget parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static HttpTarget parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static HttpTarget parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<HttpTarget> parser()
Methods
public boolean containsHeaders(String key)
HTTP request headers.
This map contains the header field names and values.
The user can specify HTTP request headers to send with the job's
HTTP request. Repeated headers are not supported, but a header value can
contain commas.
The following headers represent a subset of the headers
that accompany the job's HTTP request. Some HTTP request
headers are ignored or replaced. A partial list of headers that
are 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.
If the job has a body and the
following headers are not set by the user, Cloud Scheduler sets default
values:Content-Type: This will be set to "application/octet-stream". You
can override this default by explicitly setting Content-Type to a
particular media type when creating the job. For example, you can set
Content-Type to "application/json".
The total size of headers must be less than 80KB.
map<string, string> headers = 3;
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public HttpTarget.AuthorizationHeaderCase getAuthorizationHeaderCase()
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;
getDefaultInstanceForType()
public HttpTarget getDefaultInstanceForType()
public Map<String,String> getHeaders()
public int getHeadersCount()
HTTP request headers.
This map contains the header field names and values.
The user can specify HTTP request headers to send with the job's
HTTP request. Repeated headers are not supported, but a header value can
contain commas.
The following headers represent a subset of the headers
that accompany the job's HTTP request. Some HTTP request
headers are ignored or replaced. A partial list of headers that
are 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.
If the job has a body and the
following headers are not set by the user, Cloud Scheduler sets default
values:Content-Type: This will be set to "application/octet-stream". You
can override this default by explicitly setting Content-Type to a
particular media type when creating the job. For example, you can set
Content-Type to "application/json".
The total size of headers must be less than 80KB.
map<string, string> headers = 3;
| Returns |
| Type |
Description |
int |
|
public Map<String,String> getHeadersMap()
HTTP request headers.
This map contains the header field names and values.
The user can specify HTTP request headers to send with the job's
HTTP request. Repeated headers are not supported, but a header value can
contain commas.
The following headers represent a subset of the headers
that accompany the job's HTTP request. Some HTTP request
headers are ignored or replaced. A partial list of headers that
are 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.
If the job has a body and the
following headers are not set by the user, Cloud Scheduler sets default
values:Content-Type: This will be set to "application/octet-stream". You
can override this default by explicitly setting Content-Type to a
particular media type when creating the job. For example, you can set
Content-Type to "application/json".
The total size of headers must be less than 80KB.
map<string, string> headers = 3;
public String getHeadersOrDefault(String key, String defaultValue)
HTTP request headers.
This map contains the header field names and values.
The user can specify HTTP request headers to send with the job's
HTTP request. Repeated headers are not supported, but a header value can
contain commas.
The following headers represent a subset of the headers
that accompany the job's HTTP request. Some HTTP request
headers are ignored or replaced. A partial list of headers that
are 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.
If the job has a body and the
following headers are not set by the user, Cloud Scheduler sets default
values:Content-Type: This will be set to "application/octet-stream". You
can override this default by explicitly setting Content-Type to a
particular media type when creating the job. For example, you can set
Content-Type to "application/json".
The total size of headers must be less than 80KB.
map<string, string> headers = 3;
| Returns |
| Type |
Description |
String |
|
public String getHeadersOrThrow(String key)
HTTP request headers.
This map contains the header field names and values.
The user can specify HTTP request headers to send with the job's
HTTP request. Repeated headers are not supported, but a header value can
contain commas.
The following headers represent a subset of the headers
that accompany the job's HTTP request. Some HTTP request
headers are ignored or replaced. A partial list of headers that
are 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.
If the job has a body and the
following headers are not set by the user, Cloud Scheduler sets default
values:Content-Type: This will be set to "application/octet-stream". You
can override this default by explicitly setting Content-Type to a
particular media type when creating the job. For example, you can set
Content-Type to "application/json".
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.events.cloud.scheduler.v1.HttpMethod http_method = 2;
| Returns |
| Type |
Description |
HttpMethod |
The httpMethod.
|
getHttpMethodValue()
public int getHttpMethodValue()
Which HTTP method to use for the request.
.google.events.cloud.scheduler.v1.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.events.cloud.scheduler.v1.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.events.cloud.scheduler.v1.OAuthToken oauth_token = 5;
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.events.cloud.scheduler.v1.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.events.cloud.scheduler.v1.OidcToken oidc_token = 6;
getParserForType()
public Parser<HttpTarget> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
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.events.cloud.scheduler.v1.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.events.cloud.scheduler.v1.OidcToken oidc_token = 6;
| Returns |
| Type |
Description |
boolean |
Whether the oidcToken field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
| Name |
Description |
number |
int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public HttpTarget.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected HttpTarget.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public HttpTarget.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
