UptimeCheckConfig.HttpCheck (proto-google-cloud-monitoring-v3 3.46.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.monitoring.v3.UptimeCheckConfig.HttpCheck

All Implemented Interfaces:

UptimeCheckConfig.HttpCheckOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

UptimeCheckConfig
```
public static final class UptimeCheckConfig.HttpCheck
extends com.google.protobuf.GeneratedMessageV3
implements UptimeCheckConfig.HttpCheckOrBuilder
```
```
 Information involved in an HTTP/HTTPS Uptime check request.
 
```
Protobuf type google.monitoring.v3.UptimeCheckConfig.HttpCheck
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`UptimeCheckConfig.HttpCheck.AuthMethodCase`
`static class`	`UptimeCheckConfig.HttpCheck.BasicAuthentication` The authentication parameters to provide to the specified resource or URL that requires a username and password.
`static interface`	`UptimeCheckConfig.HttpCheck.BasicAuthenticationOrBuilder`
`static class`	`UptimeCheckConfig.HttpCheck.Builder` Information involved in an HTTP/HTTPS Uptime check request.
`static class`	`UptimeCheckConfig.HttpCheck.ContentType` Header options corresponding to the content type of a HTTP request body.
`static class`	`UptimeCheckConfig.HttpCheck.RequestMethod` The HTTP request method options.
`static class`	`UptimeCheckConfig.HttpCheck.ResponseStatusCode` A status to accept.
`static interface`	`UptimeCheckConfig.HttpCheck.ResponseStatusCodeOrBuilder`
`static class`	`UptimeCheckConfig.HttpCheck.ServiceAgentAuthentication` Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect).
`static interface`	`UptimeCheckConfig.HttpCheck.ServiceAgentAuthenticationOrBuilder`

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACCEPTED_RESPONSE_STATUS_CODES_FIELD_NUMBER`
`static int`	`AUTH_INFO_FIELD_NUMBER`
`static int`	`BODY_FIELD_NUMBER`
`static int`	`CONTENT_TYPE_FIELD_NUMBER`
`static int`	`CUSTOM_CONTENT_TYPE_FIELD_NUMBER`
`static int`	`HEADERS_FIELD_NUMBER`
`static int`	`MASK_HEADERS_FIELD_NUMBER`
`static int`	`PATH_FIELD_NUMBER`
`static int`	`PING_CONFIG_FIELD_NUMBER`
`static int`	`PORT_FIELD_NUMBER`
`static int`	`REQUEST_METHOD_FIELD_NUMBER`
`static int`	`SERVICE_AGENT_AUTHENTICATION_FIELD_NUMBER`
`static int`	`USE_SSL_FIELD_NUMBER`
`static int`	`VALIDATE_SSL_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 list of headers to send as part of the Uptime check request.
`boolean`	`equals(Object obj)`
`UptimeCheckConfig.HttpCheck.ResponseStatusCode`	`getAcceptedResponseStatusCodes(int index)` If present, the check will only pass if the HTTP response status code is in this set of status codes.
`int`	`getAcceptedResponseStatusCodesCount()` If present, the check will only pass if the HTTP response status code is in this set of status codes.
`List<UptimeCheckConfig.HttpCheck.ResponseStatusCode>`	`getAcceptedResponseStatusCodesList()` If present, the check will only pass if the HTTP response status code is in this set of status codes.
`UptimeCheckConfig.HttpCheck.ResponseStatusCodeOrBuilder`	`getAcceptedResponseStatusCodesOrBuilder(int index)` If present, the check will only pass if the HTTP response status code is in this set of status codes.
`List<? extends UptimeCheckConfig.HttpCheck.ResponseStatusCodeOrBuilder>`	`getAcceptedResponseStatusCodesOrBuilderList()` If present, the check will only pass if the HTTP response status code is in this set of status codes.
`UptimeCheckConfig.HttpCheck.BasicAuthentication`	`getAuthInfo()` The authentication information.
`UptimeCheckConfig.HttpCheck.BasicAuthenticationOrBuilder`	`getAuthInfoOrBuilder()` The authentication information.
`UptimeCheckConfig.HttpCheck.AuthMethodCase`	`getAuthMethodCase()`
`com.google.protobuf.ByteString`	`getBody()` The request body associated with the HTTP POST request.
`UptimeCheckConfig.HttpCheck.ContentType`	`getContentType()` The content type header to use for the check.
`int`	`getContentTypeValue()` The content type header to use for the check.
`String`	`getCustomContentType()` A user provided content type header to use for the check.
`com.google.protobuf.ByteString`	`getCustomContentTypeBytes()` A user provided content type header to use for the check.
`static UptimeCheckConfig.HttpCheck`	`getDefaultInstance()`
`UptimeCheckConfig.HttpCheck`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`Map<String,String>`	`getHeaders()` Deprecated.
`int`	`getHeadersCount()` The list of headers to send as part of the Uptime check request.
`Map<String,String>`	`getHeadersMap()` The list of headers to send as part of the Uptime check request.
`String`	`getHeadersOrDefault(String key, String defaultValue)` The list of headers to send as part of the Uptime check request.
`String`	`getHeadersOrThrow(String key)` The list of headers to send as part of the Uptime check request.
`boolean`	`getMaskHeaders()` Boolean specifying whether to encrypt the header information.
`com.google.protobuf.Parser<UptimeCheckConfig.HttpCheck>`	`getParserForType()`
`String`	`getPath()` Optional (defaults to "/").
`com.google.protobuf.ByteString`	`getPathBytes()` Optional (defaults to "/").
`UptimeCheckConfig.PingConfig`	`getPingConfig()` Contains information needed to add pings to an HTTP check.
`UptimeCheckConfig.PingConfigOrBuilder`	`getPingConfigOrBuilder()` Contains information needed to add pings to an HTTP check.
`int`	`getPort()` Optional (defaults to 80 when `use_ssl` is `false`, and 443 when `use_ssl` is `true`).
`UptimeCheckConfig.HttpCheck.RequestMethod`	`getRequestMethod()` The HTTP request method to use for the check.
`int`	`getRequestMethodValue()` The HTTP request method to use for the check.
`int`	`getSerializedSize()`
`UptimeCheckConfig.HttpCheck.ServiceAgentAuthentication`	`getServiceAgentAuthentication()` If specified, Uptime will generate and attach an OIDC JWT token for the Monitoring service agent service account as an `Authorization` header in the HTTP request when probing.
`UptimeCheckConfig.HttpCheck.ServiceAgentAuthenticationOrBuilder`	`getServiceAgentAuthenticationOrBuilder()` If specified, Uptime will generate and attach an OIDC JWT token for the Monitoring service agent service account as an `Authorization` header in the HTTP request when probing.
`boolean`	`getUseSsl()` If `true`, use HTTPS instead of HTTP to run the check.
`boolean`	`getValidateSsl()` Boolean specifying whether to include SSL certificate validation as a part of the Uptime check.
`boolean`	`hasAuthInfo()` The authentication information.
`int`	`hashCode()`
`boolean`	`hasPingConfig()` Contains information needed to add pings to an HTTP check.
`boolean`	`hasServiceAgentAuthentication()` If specified, Uptime will generate and attach an OIDC JWT token for the Monitoring service agent service account as an `Authorization` header in the HTTP request when probing.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMapFieldReflection(int number)`
`boolean`	`isInitialized()`
`static UptimeCheckConfig.HttpCheck.Builder`	`newBuilder()`
`static UptimeCheckConfig.HttpCheck.Builder`	`newBuilder(UptimeCheckConfig.HttpCheck prototype)`
`UptimeCheckConfig.HttpCheck.Builder`	`newBuilderForType()`
`protected UptimeCheckConfig.HttpCheck.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static UptimeCheckConfig.HttpCheck`	`parseDelimitedFrom(InputStream input)`
`static UptimeCheckConfig.HttpCheck`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static UptimeCheckConfig.HttpCheck`	`parseFrom(byte[] data)`
`static UptimeCheckConfig.HttpCheck`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static UptimeCheckConfig.HttpCheck`	`parseFrom(ByteBuffer data)`
`static UptimeCheckConfig.HttpCheck`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static UptimeCheckConfig.HttpCheck`	`parseFrom(com.google.protobuf.ByteString data)`
`static UptimeCheckConfig.HttpCheck`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static UptimeCheckConfig.HttpCheck`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static UptimeCheckConfig.HttpCheck`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static UptimeCheckConfig.HttpCheck`	`parseFrom(InputStream input)`
`static UptimeCheckConfig.HttpCheck`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<UptimeCheckConfig.HttpCheck>`	`parser()`
`UptimeCheckConfig.HttpCheck.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, getUnknownFields, hasField, hasOneof

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

Field Detail
- REQUEST_METHOD_FIELD_NUMBER
```
public static final int REQUEST_METHOD_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- USE_SSL_FIELD_NUMBER
```
public static final int USE_SSL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PATH_FIELD_NUMBER
```
public static final int PATH_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PORT_FIELD_NUMBER
```
public static final int PORT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- AUTH_INFO_FIELD_NUMBER
```
public static final int AUTH_INFO_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- MASK_HEADERS_FIELD_NUMBER
```
public static final int MASK_HEADERS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- HEADERS_FIELD_NUMBER
```
public static final int HEADERS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CONTENT_TYPE_FIELD_NUMBER
```
public static final int CONTENT_TYPE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CUSTOM_CONTENT_TYPE_FIELD_NUMBER
```
public static final int CUSTOM_CONTENT_TYPE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- VALIDATE_SSL_FIELD_NUMBER
```
public static final int VALIDATE_SSL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- BODY_FIELD_NUMBER
```
public static final int BODY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ACCEPTED_RESPONSE_STATUS_CODES_FIELD_NUMBER
```
public static final int ACCEPTED_RESPONSE_STATUS_CODES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PING_CONFIG_FIELD_NUMBER
```
public static final int PING_CONFIG_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SERVICE_AGENT_AUTHENTICATION_FIELD_NUMBER
```
public static final int SERVICE_AGENT_AUTHENTICATION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetMapFieldReflection
```
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
```
Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getAuthMethodCase
```
public UptimeCheckConfig.HttpCheck.AuthMethodCase getAuthMethodCase()
```
Specified by:

getAuthMethodCase in interface UptimeCheckConfig.HttpCheckOrBuilder

getRequestMethodValue
```
public int getRequestMethodValue()
```
```
 The HTTP request method to use for the check. If set to
 `METHOD_UNSPECIFIED` then `request_method` defaults to `GET`.
 
```
.google.monitoring.v3.UptimeCheckConfig.HttpCheck.RequestMethod request_method = 8;
Specified by:

getRequestMethodValue in interface UptimeCheckConfig.HttpCheckOrBuilder

Returns:

The enum numeric value on the wire for requestMethod.

getRequestMethod
```
public UptimeCheckConfig.HttpCheck.RequestMethod getRequestMethod()
```
```
 The HTTP request method to use for the check. If set to
 `METHOD_UNSPECIFIED` then `request_method` defaults to `GET`.
 
```
.google.monitoring.v3.UptimeCheckConfig.HttpCheck.RequestMethod request_method = 8;
Specified by:

getRequestMethod in interface UptimeCheckConfig.HttpCheckOrBuilder

Returns:

The requestMethod.

getUseSsl
```
public boolean getUseSsl()
```
```
 If `true`, use HTTPS instead of HTTP to run the check.
 
```
bool use_ssl = 1;
Specified by:

getUseSsl in interface UptimeCheckConfig.HttpCheckOrBuilder

Returns:

The useSsl.

getPath

public String getPath()

 Optional (defaults to "/"). The path to the page against which to run
 the check. Will be combined with the `host` (specified within the
 `monitored_resource`) and `port` to construct the full URL. If the
 provided path does not begin with "/", a "/" will be prepended
 automatically.

string path = 2;

Specified by:: getPath in interface UptimeCheckConfig.HttpCheckOrBuilder
Returns:: The path.

getPathBytes

public com.google.protobuf.ByteString getPathBytes()

 Optional (defaults to "/"). The path to the page against which to run
 the check. Will be combined with the `host` (specified within the
 `monitored_resource`) and `port` to construct the full URL. If the
 provided path does not begin with "/", a "/" will be prepended
 automatically.

string path = 2;

Specified by:: getPathBytes in interface UptimeCheckConfig.HttpCheckOrBuilder
Returns:: The bytes for path.

getPort

public int getPort()

 Optional (defaults to 80 when `use_ssl` is `false`, and 443 when
 `use_ssl` is `true`). The TCP port on the HTTP server against which to
 run the check. Will be combined with host (specified within the
 `monitored_resource`) and `path` to construct the full URL.

int32 port = 3;

Specified by:: getPort in interface UptimeCheckConfig.HttpCheckOrBuilder
Returns:: The port.

hasAuthInfo
```
public boolean hasAuthInfo()
```
```
 The authentication information. Optional when creating an HTTP check;
 defaults to empty.
 Do not set both `auth_method` and `auth_info`.
 
```
.google.monitoring.v3.UptimeCheckConfig.HttpCheck.BasicAuthentication auth_info = 4;
Specified by:

hasAuthInfo in interface UptimeCheckConfig.HttpCheckOrBuilder

Returns:

Whether the authInfo field is set.

getAuthInfo

public UptimeCheckConfig.HttpCheck.BasicAuthentication getAuthInfo()

 The authentication information. Optional when creating an HTTP check;
 defaults to empty.
 Do not set both `auth_method` and `auth_info`.

.google.monitoring.v3.UptimeCheckConfig.HttpCheck.BasicAuthentication auth_info = 4;

Specified by:: getAuthInfo in interface UptimeCheckConfig.HttpCheckOrBuilder
Returns:: The authInfo.

getAuthInfoOrBuilder

public UptimeCheckConfig.HttpCheck.BasicAuthenticationOrBuilder getAuthInfoOrBuilder()

 The authentication information. Optional when creating an HTTP check;
 defaults to empty.
 Do not set both `auth_method` and `auth_info`.

.google.monitoring.v3.UptimeCheckConfig.HttpCheck.BasicAuthentication auth_info = 4;

Specified by:: getAuthInfoOrBuilder in interface UptimeCheckConfig.HttpCheckOrBuilder

getMaskHeaders

public boolean getMaskHeaders()

 Boolean specifying whether to encrypt the header information.
 Encryption should be specified for any headers related to authentication
 that you do not wish to be seen when retrieving the configuration. The
 server will be responsible for encrypting the headers.
 On Get/List calls, if `mask_headers` is set to `true` then the headers
 will be obscured with `******.`

bool mask_headers = 5;

Specified by:: getMaskHeaders in interface UptimeCheckConfig.HttpCheckOrBuilder
Returns:: The maskHeaders.