HttpTarget (Google Cloud Scheduler Parent 2.3.13 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.scheduler.v1.HttpTarget

All Implemented Interfaces:: HttpTargetOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

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][google.cloud.scheduler.v1.HttpTarget.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.v1.HttpTarget

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class HttpTarget.AuthorizationHeaderCase

static class HttpTarget.Builder
Http target.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  AbstractMessageLite.InternalOneOfEnum

Nested Classes
Modifier and Type	Class and Description
`static class`	`HttpTarget.AuthorizationHeaderCase`
`static class`	`HttpTarget.Builder` Http target.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BODY_FIELD_NUMBER`
`static int`	`HEADERS_FIELD_NUMBER`
`static int`	`HTTP_METHOD_FIELD_NUMBER`
`static int`	`OAUTH_TOKEN_FIELD_NUMBER`
`static int`	`OIDC_TOKEN_FIELD_NUMBER`
`static int`	`URI_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsHeaders(String key)` The user can specify HTTP request headers to send with the job's HTTP request.
`boolean`	`equals(Object obj)`
`HttpTarget.AuthorizationHeaderCase`	`getAuthorizationHeaderCase()`
`ByteString`	`getBody()` HTTP request body.
`static HttpTarget`	`getDefaultInstance()`
`HttpTarget`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`Map<String,String>`	`getHeaders()` Deprecated.
`int`	`getHeadersCount()` The user can specify HTTP request headers to send with the job's HTTP request.
`Map<String,String>`	`getHeadersMap()` The user can specify HTTP request headers to send with the job's HTTP request.
`String`	`getHeadersOrDefault(String key, String defaultValue)` The user can specify HTTP request headers to send with the job's HTTP request.
`String`	`getHeadersOrThrow(String key)` The user can specify HTTP request headers to send with the job's HTTP request.
`HttpMethod`	`getHttpMethod()` Which HTTP method to use for the request.
`int`	`getHttpMethodValue()` 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.
`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.
`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.
`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.
`Parser<HttpTarget>`	`getParserForType()`
`int`	`getSerializedSize()`
`UnknownFieldSet`	`getUnknownFields()`
`String`	`getUri()` Required.
`ByteString`	`getUriBytes()` Required.
`int`	`hashCode()`
`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.
`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.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected MapField`	`internalGetMapField(int number)`
`boolean`	`isInitialized()`
`static HttpTarget.Builder`	`newBuilder()`
`static HttpTarget.Builder`	`newBuilder(HttpTarget prototype)`
`HttpTarget.Builder`	`newBuilderForType()`
`protected HttpTarget.Builder`	`newBuilderForType(GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)`
`static HttpTarget`	`parseDelimitedFrom(InputStream input)`
`static HttpTarget`	`parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)`
`static HttpTarget`	`parseFrom(byte[] data)`
`static HttpTarget`	`parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)`
`static HttpTarget`	`parseFrom(ByteBuffer data)`
`static HttpTarget`	`parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static HttpTarget`	`parseFrom(ByteString data)`
`static HttpTarget`	`parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)`
`static HttpTarget`	`parseFrom(CodedInputStream input)`
`static HttpTarget`	`parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`static HttpTarget`	`parseFrom(InputStream input)`
`static HttpTarget`	`parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Parser<HttpTarget>`	`parser()`
`HttpTarget.Builder`	`toBuilder()`
`void`	`writeTo(CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- URI_FIELD_NUMBER
```
public static final int URI_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- HTTP_METHOD_FIELD_NUMBER
```
public static final int HTTP_METHOD_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- HEADERS_FIELD_NUMBER
```
public static final int HEADERS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- BODY_FIELD_NUMBER
```
public static final int BODY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- OAUTH_TOKEN_FIELD_NUMBER
```
public static final int OAUTH_TOKEN_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- OIDC_TOKEN_FIELD_NUMBER
```
public static final int OIDC_TOKEN_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class GeneratedMessageV3

getUnknownFields
```
public final UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetMapField
```
protected MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class GeneratedMessageV3

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getAuthorizationHeaderCase
```
public HttpTarget.AuthorizationHeaderCase getAuthorizationHeaderCase()
```
Specified by:

getAuthorizationHeaderCase in interface HttpTargetOrBuilder

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][google.cloud.scheduler.v1.HttpTarget.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;

Specified by:: getUri in interface HttpTargetOrBuilder
Returns:: 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][google.cloud.scheduler.v1.HttpTarget.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;

Specified by:: getUriBytes in interface HttpTargetOrBuilder
Returns:: The bytes for uri.

getHttpMethodValue
```
public int getHttpMethodValue()
```
```
 Which HTTP method to use for the request.
 
```
.google.cloud.scheduler.v1.HttpMethod http_method = 2;
Specified by:

getHttpMethodValue in interface HttpTargetOrBuilder

Returns:

The enum numeric value on the wire for httpMethod.

getHttpMethod
```
public HttpMethod getHttpMethod()
```
```
 Which HTTP method to use for the request.
 
```
.google.cloud.scheduler.v1.HttpMethod http_method = 2;
Specified by:

getHttpMethod in interface HttpTargetOrBuilder

Returns:

The httpMethod.