Class UptimeCheckConfig

public final class UptimeCheckConfig extends GeneratedMessageV3 implements UptimeCheckConfigOrBuilder

This message configures which resources and services to monitor for availability.

Protobuf type google.monitoring.v3.UptimeCheckConfig

Fields

CONTENT_MATCHERS_FIELD_NUMBER

public static final int CONTENT_MATCHERS_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

HTTP_CHECK_FIELD_NUMBER

public static final int HTTP_CHECK_FIELD_NUMBER
Field Value
TypeDescription
int

INTERNAL_CHECKERS_FIELD_NUMBER

public static final int INTERNAL_CHECKERS_FIELD_NUMBER
Field Value
TypeDescription
int

IS_INTERNAL_FIELD_NUMBER

public static final int IS_INTERNAL_FIELD_NUMBER
Field Value
TypeDescription
int

MONITORED_RESOURCE_FIELD_NUMBER

public static final int MONITORED_RESOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PERIOD_FIELD_NUMBER

public static final int PERIOD_FIELD_NUMBER
Field Value
TypeDescription
int

RESOURCE_GROUP_FIELD_NUMBER

public static final int RESOURCE_GROUP_FIELD_NUMBER
Field Value
TypeDescription
int

SELECTED_REGIONS_FIELD_NUMBER

public static final int SELECTED_REGIONS_FIELD_NUMBER
Field Value
TypeDescription
int

TCP_CHECK_FIELD_NUMBER

public static final int TCP_CHECK_FIELD_NUMBER
Field Value
TypeDescription
int

TIMEOUT_FIELD_NUMBER

public static final int TIMEOUT_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCheckRequestTypeCase()

public UptimeCheckConfig.CheckRequestTypeCase getCheckRequestTypeCase()
Returns
TypeDescription
UptimeCheckConfig.CheckRequestTypeCase

getContentMatchers(int index)

public UptimeCheckConfig.ContentMatcher getContentMatchers(int index)

The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check.

repeated .google.monitoring.v3.UptimeCheckConfig.ContentMatcher content_matchers = 9;

Parameter
NameDescription
indexint
Returns
TypeDescription
UptimeCheckConfig.ContentMatcher

getContentMatchersCount()

public int getContentMatchersCount()

The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check.

repeated .google.monitoring.v3.UptimeCheckConfig.ContentMatcher content_matchers = 9;

Returns
TypeDescription
int

getContentMatchersList()

public List<UptimeCheckConfig.ContentMatcher> getContentMatchersList()

The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check.

repeated .google.monitoring.v3.UptimeCheckConfig.ContentMatcher content_matchers = 9;

Returns
TypeDescription
List<ContentMatcher>

getContentMatchersOrBuilder(int index)

public UptimeCheckConfig.ContentMatcherOrBuilder getContentMatchersOrBuilder(int index)

The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check.

repeated .google.monitoring.v3.UptimeCheckConfig.ContentMatcher content_matchers = 9;

Parameter
NameDescription
indexint
Returns
TypeDescription
UptimeCheckConfig.ContentMatcherOrBuilder

getContentMatchersOrBuilderList()

public List<? extends UptimeCheckConfig.ContentMatcherOrBuilder> getContentMatchersOrBuilderList()

The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check.

repeated .google.monitoring.v3.UptimeCheckConfig.ContentMatcher content_matchers = 9;

Returns
TypeDescription
List<? extends com.google.monitoring.v3.UptimeCheckConfig.ContentMatcherOrBuilder>

getDefaultInstance()

public static UptimeCheckConfig getDefaultInstance()
Returns
TypeDescription
UptimeCheckConfig

getDefaultInstanceForType()

public UptimeCheckConfig getDefaultInstanceForType()
Returns
TypeDescription
UptimeCheckConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDisplayName()

public String getDisplayName()

A human-friendly name for the Uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required.

string display_name = 2;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

A human-friendly name for the Uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required.

string display_name = 2;

Returns
TypeDescription
ByteString

The bytes for displayName.

getHttpCheck()

public UptimeCheckConfig.HttpCheck getHttpCheck()

Contains information needed to make an HTTP or HTTPS check.

.google.monitoring.v3.UptimeCheckConfig.HttpCheck http_check = 5;

Returns
TypeDescription
UptimeCheckConfig.HttpCheck

The httpCheck.

getHttpCheckOrBuilder()

public UptimeCheckConfig.HttpCheckOrBuilder getHttpCheckOrBuilder()

Contains information needed to make an HTTP or HTTPS check.

.google.monitoring.v3.UptimeCheckConfig.HttpCheck http_check = 5;

Returns
TypeDescription
UptimeCheckConfig.HttpCheckOrBuilder

getInternalCheckers(int index)

public InternalChecker getInternalCheckers(int index)

The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig.

repeated .google.monitoring.v3.InternalChecker internal_checkers = 14 [deprecated = true];

Parameter
NameDescription
indexint
Returns
TypeDescription
InternalChecker

getInternalCheckersCount()

public int getInternalCheckersCount()

The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig.

repeated .google.monitoring.v3.InternalChecker internal_checkers = 14 [deprecated = true];

Returns
TypeDescription
int

getInternalCheckersList()

public List<InternalChecker> getInternalCheckersList()

The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig.

repeated .google.monitoring.v3.InternalChecker internal_checkers = 14 [deprecated = true];

Returns
TypeDescription
List<InternalChecker>

getInternalCheckersOrBuilder(int index)

public InternalCheckerOrBuilder getInternalCheckersOrBuilder(int index)

The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig.

repeated .google.monitoring.v3.InternalChecker internal_checkers = 14 [deprecated = true];

Parameter
NameDescription
indexint
Returns
TypeDescription
InternalCheckerOrBuilder

getInternalCheckersOrBuilderList()

public List<? extends InternalCheckerOrBuilder> getInternalCheckersOrBuilderList()

The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig.

repeated .google.monitoring.v3.InternalChecker internal_checkers = 14 [deprecated = true];

Returns
TypeDescription
List<? extends com.google.monitoring.v3.InternalCheckerOrBuilder>

getIsInternal()

public boolean getIsInternal()

If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false.

bool is_internal = 15 [deprecated = true];

Returns
TypeDescription
boolean

The isInternal.

getMonitoredResource()

public MonitoredResource getMonitoredResource()

The monitored resource associated with the configuration. The following monitored resource types are valid for this field: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer k8s_service

.google.api.MonitoredResource monitored_resource = 3;

Returns
TypeDescription
com.google.api.MonitoredResource

The monitoredResource.

getMonitoredResourceOrBuilder()

public MonitoredResourceOrBuilder getMonitoredResourceOrBuilder()

The monitored resource associated with the configuration. The following monitored resource types are valid for this field: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer k8s_service

.google.api.MonitoredResource monitored_resource = 3;

Returns
TypeDescription
com.google.api.MonitoredResourceOrBuilder

getName()

public String getName()

A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check. This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check. This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<UptimeCheckConfig> getParserForType()
Returns
TypeDescription
Parser<UptimeCheckConfig>
Overrides

getPeriod()

public Duration getPeriod()

How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s.

.google.protobuf.Duration period = 7;

Returns
TypeDescription
Duration

The period.

getPeriodOrBuilder()

public DurationOrBuilder getPeriodOrBuilder()

How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s.

.google.protobuf.Duration period = 7;

Returns
TypeDescription
DurationOrBuilder

getResourceCase()

public UptimeCheckConfig.ResourceCase getResourceCase()
Returns
TypeDescription
UptimeCheckConfig.ResourceCase

getResourceGroup()

public UptimeCheckConfig.ResourceGroup getResourceGroup()

The group resource associated with the configuration.

.google.monitoring.v3.UptimeCheckConfig.ResourceGroup resource_group = 4;

Returns
TypeDescription
UptimeCheckConfig.ResourceGroup

The resourceGroup.

getResourceGroupOrBuilder()

public UptimeCheckConfig.ResourceGroupOrBuilder getResourceGroupOrBuilder()

The group resource associated with the configuration.

.google.monitoring.v3.UptimeCheckConfig.ResourceGroup resource_group = 4;

Returns
TypeDescription
UptimeCheckConfig.ResourceGroupOrBuilder

getSelectedRegions(int index)

public UptimeCheckRegion getSelectedRegions(int index)

The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions.

repeated .google.monitoring.v3.UptimeCheckRegion selected_regions = 10;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
UptimeCheckRegion

The selectedRegions at the given index.

getSelectedRegionsCount()

public int getSelectedRegionsCount()

The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions.

repeated .google.monitoring.v3.UptimeCheckRegion selected_regions = 10;

Returns
TypeDescription
int

The count of selectedRegions.

getSelectedRegionsList()

public List<UptimeCheckRegion> getSelectedRegionsList()

The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions.

repeated .google.monitoring.v3.UptimeCheckRegion selected_regions = 10;

Returns
TypeDescription
List<UptimeCheckRegion>

A list containing the selectedRegions.

getSelectedRegionsValue(int index)

public int getSelectedRegionsValue(int index)

The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions.

repeated .google.monitoring.v3.UptimeCheckRegion selected_regions = 10;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
int

The enum numeric value on the wire of selectedRegions at the given index.

getSelectedRegionsValueList()

public List<Integer> getSelectedRegionsValueList()

The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions.

repeated .google.monitoring.v3.UptimeCheckRegion selected_regions = 10;

Returns
TypeDescription
List<Integer>

A list containing the enum numeric values on the wire for selectedRegions.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTcpCheck()

public UptimeCheckConfig.TcpCheck getTcpCheck()

Contains information needed to make a TCP check.

.google.monitoring.v3.UptimeCheckConfig.TcpCheck tcp_check = 6;

Returns
TypeDescription
UptimeCheckConfig.TcpCheck

The tcpCheck.

getTcpCheckOrBuilder()

public UptimeCheckConfig.TcpCheckOrBuilder getTcpCheckOrBuilder()

Contains information needed to make a TCP check.

.google.monitoring.v3.UptimeCheckConfig.TcpCheck tcp_check = 6;

Returns
TypeDescription
UptimeCheckConfig.TcpCheckOrBuilder

getTimeout()

public Duration getTimeout()

The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.

.google.protobuf.Duration timeout = 8;

Returns
TypeDescription
Duration

The timeout.

getTimeoutOrBuilder()

public DurationOrBuilder getTimeoutOrBuilder()

The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.

.google.protobuf.Duration timeout = 8;

Returns
TypeDescription
DurationOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasHttpCheck()

public boolean hasHttpCheck()

Contains information needed to make an HTTP or HTTPS check.

.google.monitoring.v3.UptimeCheckConfig.HttpCheck http_check = 5;

Returns
TypeDescription
boolean

Whether the httpCheck field is set.

hasMonitoredResource()

public boolean hasMonitoredResource()

The monitored resource associated with the configuration. The following monitored resource types are valid for this field: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer k8s_service

.google.api.MonitoredResource monitored_resource = 3;

Returns
TypeDescription
boolean

Whether the monitoredResource field is set.

hasPeriod()

public boolean hasPeriod()

How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s.

.google.protobuf.Duration period = 7;

Returns
TypeDescription
boolean

Whether the period field is set.

hasResourceGroup()

public boolean hasResourceGroup()

The group resource associated with the configuration.

.google.monitoring.v3.UptimeCheckConfig.ResourceGroup resource_group = 4;

Returns
TypeDescription
boolean

Whether the resourceGroup field is set.

hasTcpCheck()

public boolean hasTcpCheck()

Contains information needed to make a TCP check.

.google.monitoring.v3.UptimeCheckConfig.TcpCheck tcp_check = 6;

Returns
TypeDescription
boolean

Whether the tcpCheck field is set.

hasTimeout()

public boolean hasTimeout()

The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.

.google.protobuf.Duration timeout = 8;

Returns
TypeDescription
boolean

Whether the timeout field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static UptimeCheckConfig.Builder newBuilder()
Returns
TypeDescription
UptimeCheckConfig.Builder

newBuilder(UptimeCheckConfig prototype)

public static UptimeCheckConfig.Builder newBuilder(UptimeCheckConfig prototype)
Parameter
NameDescription
prototypeUptimeCheckConfig
Returns
TypeDescription
UptimeCheckConfig.Builder

newBuilderForType()

public UptimeCheckConfig.Builder newBuilderForType()
Returns
TypeDescription
UptimeCheckConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UptimeCheckConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
UptimeCheckConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static UptimeCheckConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UptimeCheckConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UptimeCheckConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UptimeCheckConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static UptimeCheckConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
UptimeCheckConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UptimeCheckConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UptimeCheckConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UptimeCheckConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
UptimeCheckConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UptimeCheckConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UptimeCheckConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UptimeCheckConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
UptimeCheckConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UptimeCheckConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UptimeCheckConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static UptimeCheckConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UptimeCheckConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UptimeCheckConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UptimeCheckConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static UptimeCheckConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
UptimeCheckConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UptimeCheckConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UptimeCheckConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<UptimeCheckConfig> parser()
Returns
TypeDescription
Parser<UptimeCheckConfig>

toBuilder()

public UptimeCheckConfig.Builder toBuilder()
Returns
TypeDescription
UptimeCheckConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException