HttpTarget (Cloud Scheduler API v1beta1 (Rev. 31) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.cloudscheduler.v1beta1.model.HttpTarget

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class HttpTarget
extends com.google.api.client.json.GenericJson
```
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.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Scheduler API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

HttpTarget()

Constructors
Constructor and Description
`HttpTarget()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpTarget`	`clone()`
`byte[]`	`decodeBody()` HTTP request body.
`HttpTarget`	`encodeBody(byte[] body)` HTTP request body.
`java.lang.String`	`getBody()` HTTP request body.
`java.util.Map<java.lang.String,java.lang.String>`	`getHeaders()` The user can specify HTTP request headers to send with the job's HTTP request.
`java.lang.String`	`getHttpMethod()` Which HTTP method to use for the request.
`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.
`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.
`java.lang.String`	`getUri()` Required.
`HttpTarget`	`set(java.lang.String fieldName, java.lang.Object value)`
`HttpTarget`	`setBody(java.lang.String body)` HTTP request body.
`HttpTarget`	`setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)` The user can specify HTTP request headers to send with the job's HTTP request.
`HttpTarget`	`setHttpMethod(java.lang.String httpMethod)` Which HTTP method to use for the request.
`HttpTarget`	`setOauthToken(OAuthToken oauthToken)` 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.
`HttpTarget`	`setOidcToken(OidcToken oidcToken)` 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.
`HttpTarget`	`setUri(java.lang.String uri)` Required.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - HttpTarget
```
public HttpTarget()
```
- Method Detail
  - getBody
```
public java.lang.String 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.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodeBody()
  - decodeBody
```
public byte[] decodeBody()
```
    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.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getBody()
  - setBody
```
public HttpTarget setBody(java.lang.String body)
```
    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.
    
    Parameters:
    
    body - body or null for none
    
    See Also:
    
    #encodeBody()
  - encodeBody
```
public HttpTarget encodeBody(byte[] body)
```
    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.
    
    Since:
    
    1.14
    
    See Also:
    
    The value is encoded Base64 or {@code null} for none.
  - getHeaders
```
public java.util.Map<java.lang.String,java.lang.String> getHeaders()
```
    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. The total size of headers must be less than 80KB.
    
    Returns:
    
    value or null for none
  - setHeaders
```
public HttpTarget setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)
```
    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. The total size of headers must be less than 80KB.
    
    Parameters:
    
    headers - headers or null for none
  - getHttpMethod
```
public java.lang.String getHttpMethod()
```
    Which HTTP method to use for the request.
    
    Returns:
    
    value or null for none
  - setHttpMethod
```
public HttpTarget setHttpMethod(java.lang.String httpMethod)
```
    Which HTTP method to use for the request.
    
    Parameters:
    
    httpMethod - httpMethod or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setOauthToken
```
public HttpTarget setOauthToken(OAuthToken oauthToken)
```
    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.
    
    Parameters:
    
    oauthToken - oauthToken or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setOidcToken
```
public HttpTarget setOidcToken(OidcToken oidcToken)
```
    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.
    
    Parameters:
    
    oidcToken - oidcToken or null for none
  - getUri
```
public java.lang.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.
    
    Returns:
    
    value or null for none
  - setUri
```
public HttpTarget setUri(java.lang.String uri)
```
    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.
    
    Parameters:
    
    uri - uri or null for none
  - set
```
public HttpTarget set(java.lang.String fieldName,
                      java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public HttpTarget clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Cloud Scheduler API v1beta1 (revision 31)

Class HttpTarget

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

HttpTarget

Method Detail

getBody

decodeBody

setBody

encodeBody

getHeaders

setHeaders

getHttpMethod

setHttpMethod

getOauthToken

setOauthToken

getOidcToken

setOidcToken

getUri

setUri

set

clone