Package com.google.cloud.tasks.v2beta2

Class HttpTarget

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.tasks.v2beta2.HttpTarget
All Implemented Interfaces:
HttpTargetOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class HttpTarget extends com.google.protobuf.GeneratedMessage implements HttpTargetOrBuilder
 HTTP target.

 When specified as a [Queue][target_type], all the tasks with [HttpRequest]
 will be overridden according to the target.
Protobuf type google.cloud.tasks.v2beta2.HttpTarget
See Also:

  • Field Details

    • URI_OVERRIDE_FIELD_NUMBER

      public static final int URI_OVERRIDE_FIELD_NUMBER
      See Also:

    • HTTP_METHOD_FIELD_NUMBER

      public static final int HTTP_METHOD_FIELD_NUMBER
      See Also:

    • HEADER_OVERRIDES_FIELD_NUMBER

      public static final int HEADER_OVERRIDES_FIELD_NUMBER
      See Also:

    • OAUTH_TOKEN_FIELD_NUMBER

      public static final int OAUTH_TOKEN_FIELD_NUMBER
      See Also:

    • OIDC_TOKEN_FIELD_NUMBER

      public static final int OIDC_TOKEN_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getAuthorizationHeaderCase

      public HttpTarget.AuthorizationHeaderCase getAuthorizationHeaderCase()
      Specified by:
      getAuthorizationHeaderCase in interface HttpTargetOrBuilder

    • hasUriOverride

      public boolean hasUriOverride()
       Uri override.

 When specified, overrides the execution Uri for all the tasks in the queue.
      .google.cloud.tasks.v2beta2.UriOverride uri_override = 1;
      Specified by:
      hasUriOverride in interface HttpTargetOrBuilder
      Returns:
      Whether the uriOverride field is set.

    • getUriOverride

      public UriOverride getUriOverride()
       Uri override.

 When specified, overrides the execution Uri for all the tasks in the queue.
      .google.cloud.tasks.v2beta2.UriOverride uri_override = 1;
      Specified by:
      getUriOverride in interface HttpTargetOrBuilder
      Returns:
      The uriOverride.

    • getUriOverrideOrBuilder

      public UriOverrideOrBuilder getUriOverrideOrBuilder()
       Uri override.

 When specified, overrides the execution Uri for all the tasks in the queue.
      .google.cloud.tasks.v2beta2.UriOverride uri_override = 1;
      Specified by:
      getUriOverrideOrBuilder in interface HttpTargetOrBuilder

    • getHttpMethodValue

      public int getHttpMethodValue()
       The HTTP method to use for the request.

 When specified, it overrides
 [HttpRequest][google.cloud.tasks.v2beta2.HttpTarget.http_method] for the
 task. Note that if the value is set to [HttpMethod][GET] the
 [HttpRequest][body] of the task will be ignored at execution time.
      .google.cloud.tasks.v2beta2.HttpMethod http_method = 2;
      Specified by:
      getHttpMethodValue in interface HttpTargetOrBuilder
      Returns:
      The enum numeric value on the wire for httpMethod.

    • getHttpMethod

      public HttpMethod getHttpMethod()
       The HTTP method to use for the request.

 When specified, it overrides
 [HttpRequest][google.cloud.tasks.v2beta2.HttpTarget.http_method] for the
 task. Note that if the value is set to [HttpMethod][GET] the
 [HttpRequest][body] of the task will be ignored at execution time.
      .google.cloud.tasks.v2beta2.HttpMethod http_method = 2;
      Specified by:
      getHttpMethod in interface HttpTargetOrBuilder
      Returns:
      The httpMethod.

    • getHeaderOverridesList

      public List<HttpTarget.HeaderOverride> getHeaderOverridesList()
       HTTP target headers.

 This map contains the header field names and values.
 Headers will be set when running the
 [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] and/or
 [task is created][google.cloud.tasks.v2beta2.CloudTasks.BufferTask].

 These headers represent a subset of the headers that will accompany the
 task's HTTP request. Some HTTP request headers will be ignored or replaced.

 A partial list of headers that will be ignored or replaced is:
 * Any header that is prefixed with "X-CloudTasks-" will be treated
 as service header. Service headers define properties of the task and are
 predefined in CloudTask.
 * Host: This will be computed by Cloud Tasks and derived from
 [HttpRequest.url][google.cloud.tasks.v2beta2.HttpRequest.url].
 * Content-Length: This will be computed by Cloud Tasks.
 * User-Agent: This will be set to `"Google-CloudTasks"`.
 * `X-Google-*`: Google use only.
 * `X-AppEngine-*`: Google use only.

 `Content-Type` won't be set by Cloud Tasks. You can explicitly set
 `Content-Type` to a media type when the
 [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
 For example, `Content-Type` can be set to `"application/octet-stream"` or
 `"application/json"`.

 Headers which can have multiple values (according to RFC2616) can be
 specified using comma-separated values.

 The size of the headers must be less than 80KB.
 Queue-level headers to override headers of all the tasks in the queue.
      repeated .google.cloud.tasks.v2beta2.HttpTarget.HeaderOverride header_overrides = 3;
      Specified by:
      getHeaderOverridesList in interface HttpTargetOrBuilder

    • getHeaderOverridesOrBuilderList

      public List<? extends HttpTarget.HeaderOverrideOrBuilder> getHeaderOverridesOrBuilderList()
       HTTP target headers.

 This map contains the header field names and values.
 Headers will be set when running the
 [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] and/or
 [task is created][google.cloud.tasks.v2beta2.CloudTasks.BufferTask].

 These headers represent a subset of the headers that will accompany the
 task's HTTP request. Some HTTP request headers will be ignored or replaced.

 A partial list of headers that will be ignored or replaced is:
 * Any header that is prefixed with "X-CloudTasks-" will be treated
 as service header. Service headers define properties of the task and are
 predefined in CloudTask.
 * Host: This will be computed by Cloud Tasks and derived from
 [HttpRequest.url][google.cloud.tasks.v2beta2.HttpRequest.url].
 * Content-Length: This will be computed by Cloud Tasks.
 * User-Agent: This will be set to `"Google-CloudTasks"`.
 * `X-Google-*`: Google use only.
 * `X-AppEngine-*`: Google use only.

 `Content-Type` won't be set by Cloud Tasks. You can explicitly set
 `Content-Type` to a media type when the
 [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
 For example, `Content-Type` can be set to `"application/octet-stream"` or
 `"application/json"`.

 Headers which can have multiple values (according to RFC2616) can be
 specified using comma-separated values.

 The size of the headers must be less than 80KB.
 Queue-level headers to override headers of all the tasks in the queue.
      repeated .google.cloud.tasks.v2beta2.HttpTarget.HeaderOverride header_overrides = 3;
      Specified by:
      getHeaderOverridesOrBuilderList in interface HttpTargetOrBuilder

    • getHeaderOverridesCount

      public int getHeaderOverridesCount()
       HTTP target headers.

 This map contains the header field names and values.
 Headers will be set when running the
 [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] and/or
 [task is created][google.cloud.tasks.v2beta2.CloudTasks.BufferTask].

 These headers represent a subset of the headers that will accompany the
 task's HTTP request. Some HTTP request headers will be ignored or replaced.

 A partial list of headers that will be ignored or replaced is:
 * Any header that is prefixed with "X-CloudTasks-" will be treated
 as service header. Service headers define properties of the task and are
 predefined in CloudTask.
 * Host: This will be computed by Cloud Tasks and derived from
 [HttpRequest.url][google.cloud.tasks.v2beta2.HttpRequest.url].
 * Content-Length: This will be computed by Cloud Tasks.
 * User-Agent: This will be set to `"Google-CloudTasks"`.
 * `X-Google-*`: Google use only.
 * `X-AppEngine-*`: Google use only.

 `Content-Type` won't be set by Cloud Tasks. You can explicitly set
 `Content-Type` to a media type when the
 [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
 For example, `Content-Type` can be set to `"application/octet-stream"` or
 `"application/json"`.

 Headers which can have multiple values (according to RFC2616) can be
 specified using comma-separated values.

 The size of the headers must be less than 80KB.
 Queue-level headers to override headers of all the tasks in the queue.
      repeated .google.cloud.tasks.v2beta2.HttpTarget.HeaderOverride header_overrides = 3;
      Specified by:
      getHeaderOverridesCount in interface HttpTargetOrBuilder

    • getHeaderOverrides

      public HttpTarget.HeaderOverride getHeaderOverrides(int index)
       HTTP target headers.

 This map contains the header field names and values.
 Headers will be set when running the
 [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] and/or
 [task is created][google.cloud.tasks.v2beta2.CloudTasks.BufferTask].

 These headers represent a subset of the headers that will accompany the
 task's HTTP request. Some HTTP request headers will be ignored or replaced.

 A partial list of headers that will be ignored or replaced is:
 * Any header that is prefixed with "X-CloudTasks-" will be treated
 as service header. Service headers define properties of the task and are
 predefined in CloudTask.
 * Host: This will be computed by Cloud Tasks and derived from
 [HttpRequest.url][google.cloud.tasks.v2beta2.HttpRequest.url].
 * Content-Length: This will be computed by Cloud Tasks.
 * User-Agent: This will be set to `"Google-CloudTasks"`.
 * `X-Google-*`: Google use only.
 * `X-AppEngine-*`: Google use only.

 `Content-Type` won't be set by Cloud Tasks. You can explicitly set
 `Content-Type` to a media type when the
 [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
 For example, `Content-Type` can be set to `"application/octet-stream"` or
 `"application/json"`.

 Headers which can have multiple values (according to RFC2616) can be
 specified using comma-separated values.

 The size of the headers must be less than 80KB.
 Queue-level headers to override headers of all the tasks in the queue.
      repeated .google.cloud.tasks.v2beta2.HttpTarget.HeaderOverride header_overrides = 3;
      Specified by:
      getHeaderOverrides in interface HttpTargetOrBuilder

    • getHeaderOverridesOrBuilder

      public HttpTarget.HeaderOverrideOrBuilder getHeaderOverridesOrBuilder(int index)
       HTTP target headers.

 This map contains the header field names and values.
 Headers will be set when running the
 [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] and/or
 [task is created][google.cloud.tasks.v2beta2.CloudTasks.BufferTask].

 These headers represent a subset of the headers that will accompany the
 task's HTTP request. Some HTTP request headers will be ignored or replaced.

 A partial list of headers that will be ignored or replaced is:
 * Any header that is prefixed with "X-CloudTasks-" will be treated
 as service header. Service headers define properties of the task and are
 predefined in CloudTask.
 * Host: This will be computed by Cloud Tasks and derived from
 [HttpRequest.url][google.cloud.tasks.v2beta2.HttpRequest.url].
 * Content-Length: This will be computed by Cloud Tasks.
 * User-Agent: This will be set to `"Google-CloudTasks"`.
 * `X-Google-*`: Google use only.
 * `X-AppEngine-*`: Google use only.

 `Content-Type` won't be set by Cloud Tasks. You can explicitly set
 `Content-Type` to a media type when the
 [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
 For example, `Content-Type` can be set to `"application/octet-stream"` or
 `"application/json"`.

 Headers which can have multiple values (according to RFC2616) can be
 specified using comma-separated values.

 The size of the headers must be less than 80KB.
 Queue-level headers to override headers of all the tasks in the queue.
      repeated .google.cloud.tasks.v2beta2.HttpTarget.HeaderOverride header_overrides = 3;
      Specified by:
      getHeaderOverridesOrBuilder in interface HttpTargetOrBuilder

    • hasOauthToken

      public boolean hasOauthToken()
       If specified, an
 [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
 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.tasks.v2beta2.OAuthToken oauth_token = 5;
      Specified by:
      hasOauthToken in interface HttpTargetOrBuilder
      Returns:
      Whether the oauthToken field is set.

    • getOauthToken

      public OAuthToken getOauthToken()
       If specified, an
 [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
 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.tasks.v2beta2.OAuthToken oauth_token = 5;
      Specified by:
      getOauthToken in interface HttpTargetOrBuilder
      Returns:
      The oauthToken.

    • getOauthTokenOrBuilder

      public OAuthTokenOrBuilder getOauthTokenOrBuilder()
       If specified, an
 [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
 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.tasks.v2beta2.OAuthToken oauth_token = 5;
      Specified by:
      getOauthTokenOrBuilder in interface HttpTargetOrBuilder

    • hasOidcToken

      public boolean hasOidcToken()
       If specified, an
 [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
 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.tasks.v2beta2.OidcToken oidc_token = 6;
      Specified by:
      hasOidcToken in interface HttpTargetOrBuilder
      Returns:
      Whether the oidcToken field is set.

    • getOidcToken

      public OidcToken getOidcToken()
       If specified, an
 [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
 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.tasks.v2beta2.OidcToken oidc_token = 6;
      Specified by:
      getOidcToken in interface HttpTargetOrBuilder
      Returns:
      The oidcToken.

    • getOidcTokenOrBuilder

      public OidcTokenOrBuilder getOidcTokenOrBuilder()
       If specified, an
 [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
 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.tasks.v2beta2.OidcToken oidc_token = 6;
      Specified by:
      getOidcTokenOrBuilder in interface HttpTargetOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static HttpTarget parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HttpTarget parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HttpTarget parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HttpTarget parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HttpTarget parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HttpTarget parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HttpTarget parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HttpTarget parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static HttpTarget parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static HttpTarget parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HttpTarget parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HttpTarget parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public HttpTarget.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static HttpTarget.Builder newBuilder()

    • newBuilder

      public static HttpTarget.Builder newBuilder(HttpTarget prototype)

    • toBuilder

      public HttpTarget.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected HttpTarget.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static HttpTarget getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<HttpTarget> parser()

    • getParserForType

      public com.google.protobuf.Parser<HttpTarget> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public HttpTarget getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder