Interface UptimeCheckConfigOrBuilder (3.16.0)

Version 3.16.0

• 3.54.0 (latest)
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.6
• 3.3.6
• 3.2.10

public interface UptimeCheckConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCheckRequestTypeCase()

public abstract UptimeCheckConfig.CheckRequestTypeCase getCheckRequestTypeCase()

Returns
Type	Description
UptimeCheckConfig.CheckRequestTypeCase

getContentMatchers(int index)

public abstract 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
Name	Description
index	int

Returns
Type	Description
UptimeCheckConfig.ContentMatcher

getContentMatchersCount()

public abstract 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
Type	Description
int

getContentMatchersList()

public abstract 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
Type	Description
List<ContentMatcher>

getContentMatchersOrBuilder(int index)

public abstract 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
Name	Description
index	int

Returns
Type	Description
UptimeCheckConfig.ContentMatcherOrBuilder

getContentMatchersOrBuilderList()

public abstract 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
Type	Description
List<? extends com.google.monitoring.v3.UptimeCheckConfig.ContentMatcherOrBuilder>

getDisplayName()

public abstract 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
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract 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
Type	Description
ByteString	The bytes for displayName.

getHttpCheck()

public abstract UptimeCheckConfig.HttpCheck getHttpCheck()

Contains information needed to make an HTTP or HTTPS check.

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

Returns
Type	Description
UptimeCheckConfig.HttpCheck	The httpCheck.

getHttpCheckOrBuilder()

public abstract UptimeCheckConfig.HttpCheckOrBuilder getHttpCheckOrBuilder()

Contains information needed to make an HTTP or HTTPS check.

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

Returns
Type	Description
UptimeCheckConfig.HttpCheckOrBuilder

getInternalCheckers(int index)

public abstract 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
Name	Description
index	int

Returns
Type	Description
InternalChecker

getInternalCheckersCount()

public abstract 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
Type	Description
int

getInternalCheckersList()

public abstract 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
Type	Description
List<InternalChecker>

getInternalCheckersOrBuilder(int index)

public abstract 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
Name	Description
index	int

Returns
Type	Description
InternalCheckerOrBuilder

getInternalCheckersOrBuilderList()

public abstract 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
Type	Description
List<? extends com.google.monitoring.v3.InternalCheckerOrBuilder>

getIsInternal() (deprecated)

public abstract boolean getIsInternal()

Deprecated. google.monitoring.v3.UptimeCheckConfig.is_internal is deprecated. See google/monitoring/v3/uptime.proto;l=359

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
Type	Description
boolean	The isInternal.

getMonitoredResource()

public abstract 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
Type	Description
com.google.api.MonitoredResource	The monitoredResource.

getMonitoredResourceOrBuilder()

public abstract 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
Type	Description
com.google.api.MonitoredResourceOrBuilder

getName()

public abstract 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
Type	Description
String	The name.

getNameBytes()

public abstract 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
Type	Description
ByteString	The bytes for name.

getPeriod()

public abstract 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
Type	Description
Duration	The period.

getPeriodOrBuilder()

public abstract 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
Type	Description
DurationOrBuilder

getResourceCase()

public abstract UptimeCheckConfig.ResourceCase getResourceCase()

Returns
Type	Description
UptimeCheckConfig.ResourceCase

getResourceGroup()

public abstract UptimeCheckConfig.ResourceGroup getResourceGroup()

The group resource associated with the configuration.

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

Returns
Type	Description
UptimeCheckConfig.ResourceGroup	The resourceGroup.

getResourceGroupOrBuilder()

public abstract UptimeCheckConfig.ResourceGroupOrBuilder getResourceGroupOrBuilder()

The group resource associated with the configuration.

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

Returns
Type	Description
UptimeCheckConfig.ResourceGroupOrBuilder

getSelectedRegions(int index)

public abstract 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
Name	Description
index	int The index of the element to return.

Returns
Type	Description
UptimeCheckRegion	The selectedRegions at the given index.

getSelectedRegionsCount()

public abstract 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
Type	Description
int	The count of selectedRegions.

getSelectedRegionsList()

public abstract 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
Type	Description
List<UptimeCheckRegion>	A list containing the selectedRegions.

getSelectedRegionsValue(int index)

public abstract 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
Name	Description
index	int The index of the value to return.

Returns
Type	Description
int	The enum numeric value on the wire of selectedRegions at the given index.

getSelectedRegionsValueList()

public abstract 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
Type	Description
List<Integer>	A list containing the enum numeric values on the wire for selectedRegions.

getTcpCheck()

public abstract UptimeCheckConfig.TcpCheck getTcpCheck()

Contains information needed to make a TCP check.

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

Returns
Type	Description
UptimeCheckConfig.TcpCheck	The tcpCheck.

getTcpCheckOrBuilder()

public abstract UptimeCheckConfig.TcpCheckOrBuilder getTcpCheckOrBuilder()

Contains information needed to make a TCP check.

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

Returns
Type	Description
UptimeCheckConfig.TcpCheckOrBuilder

getTimeout()

public abstract 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
Type	Description
Duration	The timeout.

getTimeoutOrBuilder()

public abstract 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
Type	Description
DurationOrBuilder

hasHttpCheck()

public abstract boolean hasHttpCheck()

Contains information needed to make an HTTP or HTTPS check.

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

Returns
Type	Description
boolean	Whether the httpCheck field is set.

hasMonitoredResource()

public abstract 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
Type	Description
boolean	Whether the monitoredResource field is set.

hasPeriod()

public abstract 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
Type	Description
boolean	Whether the period field is set.

hasResourceGroup()

public abstract boolean hasResourceGroup()

The group resource associated with the configuration.

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

Returns
Type	Description
boolean	Whether the resourceGroup field is set.

hasTcpCheck()

public abstract boolean hasTcpCheck()

Contains information needed to make a TCP check.

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

Returns
Type	Description
boolean	Whether the tcpCheck field is set.

hasTimeout()

public abstract 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
Type	Description
boolean	Whether the timeout field is set.