Class HttpTarget (2.24.0)

publicfinalclass HttpTargetextendsGeneratedMessageV3implementsHttpTargetOrBuilder

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

Inherited Members

publicstaticfinalintBODY_FIELD_NUMBER

publicstaticfinalintHEADERS_FIELD_NUMBER

publicstaticfinalintHTTP_METHOD_FIELD_NUMBER

publicstaticfinalintOAUTH_TOKEN_FIELD_NUMBER

publicstaticfinalintOIDC_TOKEN_FIELD_NUMBER

publicstaticfinalintURI_FIELD_NUMBER

publicstaticHttpTargetgetDefaultInstance()

publicstaticfinalDescriptors.DescriptorgetDescriptor()

publicstaticHttpTarget.BuildernewBuilder()

publicstaticHttpTarget.BuildernewBuilder(HttpTargetprototype)

publicstaticHttpTargetparseDelimitedFrom(InputStreaminput)

publicstaticHttpTargetparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticHttpTargetparseFrom(byte[]data)

publicstaticHttpTargetparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)

publicstaticHttpTargetparseFrom(ByteStringdata)

publicstaticHttpTargetparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)

publicstaticHttpTargetparseFrom(CodedInputStreaminput)

publicstaticHttpTargetparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticHttpTargetparseFrom(InputStreaminput)

publicstaticHttpTargetparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticHttpTargetparseFrom(ByteBufferdata)

publicstaticHttpTargetparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)

publicstaticParser<HttpTarget>parser()

publicbooleancontainsHeaders(Stringkey)

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 time in RFC3339 UTC "Zulu" format.

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

map<string, string> headers = 3;

publicbooleanequals(Objectobj)

AbstractMessage.equals(Object other)

publicHttpTarget.AuthorizationHeaderCasegetAuthorizationHeaderCase()

publicByteStringgetBody()

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;

publicHttpTargetgetDefaultInstanceForType()

publicMap<String,String>getHeaders()

Use #getHeadersMap() instead.

publicintgetHeadersCount()

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 time in RFC3339 UTC "Zulu" format.

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

map<string, string> headers = 3;

publicMap<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 time in RFC3339 UTC "Zulu" format.

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

map<string, string> headers = 3;

publicStringgetHeadersOrDefault(Stringkey,StringdefaultValue)

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 time in RFC3339 UTC "Zulu" format.

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

map<string, string> headers = 3;

publicStringgetHeadersOrThrow(Stringkey)

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 time in RFC3339 UTC "Zulu" format.

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

map<string, string> headers = 3;

publicHttpMethodgetHttpMethod()

Which HTTP method to use for the request.

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

publicintgetHttpMethodValue()

Which HTTP method to use for the request.

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

publicOAuthTokengetOauthToken()

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;

publicOAuthTokenOrBuildergetOauthTokenOrBuilder()

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;

publicOidcTokengetOidcToken()

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;

publicOidcTokenOrBuildergetOidcTokenOrBuilder()

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;

publicParser<HttpTarget>getParserForType()

GeneratedMessageV3.getParserForType()

publicintgetSerializedSize()

GeneratedMessageV3.getSerializedSize()

publicStringgetUri()

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;

publicByteStringgetUriBytes()

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;

publicbooleanhasOauthToken()

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;

publicbooleanhasOidcToken()

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;

publicinthashCode()

AbstractMessage.hashCode()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()

GeneratedMessageV3.internalGetFieldAccessorTable()

protectedMapFieldinternalGetMapField(intnumber)

GeneratedMessageV3.internalGetMapField(int fieldNumber)

publicfinalbooleanisInitialized()

GeneratedMessageV3.isInitialized()

publicHttpTarget.BuildernewBuilderForType()

protectedHttpTarget.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

publicHttpTarget.BuildertoBuilder()

publicvoidwriteTo(CodedOutputStreamoutput)

GeneratedMessageV3.writeTo(CodedOutputStream output)