UptimeCheckConfigOrBuilder (proto-google-cloud-monitoring-v3 3.52.0 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

UptimeCheckConfig, UptimeCheckConfig.Builder
```
public interface UptimeCheckConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsUserLabels(String key)` User-supplied key/value data to be used for organizing and identifying the `UptimeCheckConfig` objects.
`UptimeCheckConfig.CheckerType`	`getCheckerType()` The type of checkers to use to execute the Uptime check.
`int`	`getCheckerTypeValue()` The type of checkers to use to execute the Uptime check.
`UptimeCheckConfig.CheckRequestTypeCase`	`getCheckRequestTypeCase()`
`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.
`int`	`getContentMatchersCount()` The content that is expected to appear in the data returned by the target server against which the check is run.
`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.
`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.
`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.
`String`	`getDisplayName()` A human-friendly name for the Uptime check configuration.
`com.google.protobuf.ByteString`	`getDisplayNameBytes()` A human-friendly name for the Uptime check configuration.
`UptimeCheckConfig.HttpCheck`	`getHttpCheck()` Contains information needed to make an HTTP or HTTPS check.
`UptimeCheckConfig.HttpCheckOrBuilder`	`getHttpCheckOrBuilder()` Contains information needed to make an HTTP or HTTPS check.
`InternalChecker`	`getInternalCheckers(int index)` Deprecated.
`int`	`getInternalCheckersCount()` Deprecated.
`List<InternalChecker>`	`getInternalCheckersList()` Deprecated.
`InternalCheckerOrBuilder`	`getInternalCheckersOrBuilder(int index)` Deprecated.
`List<? extends InternalCheckerOrBuilder>`	`getInternalCheckersOrBuilderList()` Deprecated.
`boolean`	`getIsInternal()` Deprecated. google.monitoring.v3.UptimeCheckConfig.is_internal is deprecated. See google/monitoring/v3/uptime.proto;l=545
`com.google.api.MonitoredResource`	`getMonitoredResource()` The [monitored resource](https://cloud.google.com/monitoring/api/resources) associated with the configuration.
`com.google.api.MonitoredResourceOrBuilder`	`getMonitoredResourceOrBuilder()` The [monitored resource](https://cloud.google.com/monitoring/api/resources) associated with the configuration.
`String`	`getName()` Identifier.
`com.google.protobuf.ByteString`	`getNameBytes()` Identifier.
`com.google.protobuf.Duration`	`getPeriod()` How often, in seconds, the Uptime check is performed.
`com.google.protobuf.DurationOrBuilder`	`getPeriodOrBuilder()` How often, in seconds, the Uptime check is performed.
`UptimeCheckConfig.ResourceCase`	`getResourceCase()`
`UptimeCheckConfig.ResourceGroup`	`getResourceGroup()` The group resource associated with the configuration.
`UptimeCheckConfig.ResourceGroupOrBuilder`	`getResourceGroupOrBuilder()` The group resource associated with the configuration.
`UptimeCheckRegion`	`getSelectedRegions(int index)` The list of regions from which the check will be run.
`int`	`getSelectedRegionsCount()` The list of regions from which the check will be run.
`List<UptimeCheckRegion>`	`getSelectedRegionsList()` The list of regions from which the check will be run.
`int`	`getSelectedRegionsValue(int index)` The list of regions from which the check will be run.
`List<Integer>`	`getSelectedRegionsValueList()` The list of regions from which the check will be run.
`SyntheticMonitorTarget`	`getSyntheticMonitor()` Specifies a Synthetic Monitor to invoke.
`SyntheticMonitorTargetOrBuilder`	`getSyntheticMonitorOrBuilder()` Specifies a Synthetic Monitor to invoke.
`UptimeCheckConfig.TcpCheck`	`getTcpCheck()` Contains information needed to make a TCP check.
`UptimeCheckConfig.TcpCheckOrBuilder`	`getTcpCheckOrBuilder()` Contains information needed to make a TCP check.
`com.google.protobuf.Duration`	`getTimeout()` The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds).
`com.google.protobuf.DurationOrBuilder`	`getTimeoutOrBuilder()` The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds).
`Map<String,String>`	`getUserLabels()` Deprecated.
`int`	`getUserLabelsCount()` User-supplied key/value data to be used for organizing and identifying the `UptimeCheckConfig` objects.
`Map<String,String>`	`getUserLabelsMap()` User-supplied key/value data to be used for organizing and identifying the `UptimeCheckConfig` objects.
`String`	`getUserLabelsOrDefault(String key, String defaultValue)` User-supplied key/value data to be used for organizing and identifying the `UptimeCheckConfig` objects.
`String`	`getUserLabelsOrThrow(String key)` User-supplied key/value data to be used for organizing and identifying the `UptimeCheckConfig` objects.
`boolean`	`hasHttpCheck()` Contains information needed to make an HTTP or HTTPS check.
`boolean`	`hasMonitoredResource()` The [monitored resource](https://cloud.google.com/monitoring/api/resources) associated with the configuration.
`boolean`	`hasPeriod()` How often, in seconds, the Uptime check is performed.
`boolean`	`hasResourceGroup()` The group resource associated with the configuration.
`boolean`	`hasSyntheticMonitor()` Specifies a Synthetic Monitor to invoke.
`boolean`	`hasTcpCheck()` Contains information needed to make a TCP check.
`boolean`	`hasTimeout()` The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds).

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Method Detail

getName

String getName()

 Identifier. 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 [(.google.api.field_behavior) = IDENTIFIER];

Returns:: The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Identifier. 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 [(.google.api.field_behavior) = IDENTIFIER];

Returns:: The bytes for name.

getDisplayName

String getDisplayName()

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

string display_name = 2;

Returns:: The displayName.

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

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

string display_name = 2;

Returns:: The bytes for displayName.

hasMonitoredResource

boolean hasMonitoredResource()

 The [monitored
 resource](https://cloud.google.com/monitoring/api/resources) 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`
   `servicedirectory_service`
   `cloud_run_revision`

.google.api.MonitoredResource monitored_resource = 3;

Returns:: Whether the monitoredResource field is set.

getMonitoredResource

com.google.api.MonitoredResource getMonitoredResource()

 The [monitored
 resource](https://cloud.google.com/monitoring/api/resources) 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`
   `servicedirectory_service`
   `cloud_run_revision`

.google.api.MonitoredResource monitored_resource = 3;

Returns:: The monitoredResource.

getMonitoredResourceOrBuilder

com.google.api.MonitoredResourceOrBuilder getMonitoredResourceOrBuilder()

 The [monitored
 resource](https://cloud.google.com/monitoring/api/resources) 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`
   `servicedirectory_service`
   `cloud_run_revision`

.google.api.MonitoredResource monitored_resource = 3;

hasResourceGroup
```
boolean hasResourceGroup()
```
```
 The group resource associated with the configuration.
 
```
.google.monitoring.v3.UptimeCheckConfig.ResourceGroup resource_group = 4;
Returns:

Whether the resourceGroup field is set.

getResourceGroup
```
UptimeCheckConfig.ResourceGroup getResourceGroup()
```
```
 The group resource associated with the configuration.
 
```
.google.monitoring.v3.UptimeCheckConfig.ResourceGroup resource_group = 4;
Returns:

The resourceGroup.

getResourceGroupOrBuilder

UptimeCheckConfig.ResourceGroupOrBuilder getResourceGroupOrBuilder()

 The group resource associated with the configuration.

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

hasSyntheticMonitor
```
boolean hasSyntheticMonitor()
```
```
 Specifies a Synthetic Monitor to invoke.
 
```
.google.monitoring.v3.SyntheticMonitorTarget synthetic_monitor = 21;
Returns:

Whether the syntheticMonitor field is set.

getSyntheticMonitor
```
SyntheticMonitorTarget getSyntheticMonitor()
```
```
 Specifies a Synthetic Monitor to invoke.
 
```
.google.monitoring.v3.SyntheticMonitorTarget synthetic_monitor = 21;
Returns:

The syntheticMonitor.

getSyntheticMonitorOrBuilder

SyntheticMonitorTargetOrBuilder getSyntheticMonitorOrBuilder()

 Specifies a Synthetic Monitor to invoke.

.google.monitoring.v3.SyntheticMonitorTarget synthetic_monitor = 21;

hasHttpCheck
```
boolean hasHttpCheck()
```
```
 Contains information needed to make an HTTP or HTTPS check.
 
```
.google.monitoring.v3.UptimeCheckConfig.HttpCheck http_check = 5;
Returns:

Whether the httpCheck field is set.

getHttpCheck

UptimeCheckConfig.HttpCheck getHttpCheck()

 Contains information needed to make an HTTP or HTTPS check.

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

Returns:: The httpCheck.

getHttpCheckOrBuilder

UptimeCheckConfig.HttpCheckOrBuilder getHttpCheckOrBuilder()

 Contains information needed to make an HTTP or HTTPS check.

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

hasTcpCheck
```
boolean hasTcpCheck()
```
```
 Contains information needed to make a TCP check.
 
```
.google.monitoring.v3.UptimeCheckConfig.TcpCheck tcp_check = 6;
Returns:

Whether the tcpCheck field is set.

getTcpCheck

UptimeCheckConfig.TcpCheck getTcpCheck()

 Contains information needed to make a TCP check.

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

Returns:: The tcpCheck.

getTcpCheckOrBuilder

UptimeCheckConfig.TcpCheckOrBuilder getTcpCheckOrBuilder()

 Contains information needed to make a TCP check.

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

hasPeriod

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:: Whether the period field is set.

getPeriod

com.google.protobuf.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:: The period.

getPeriodOrBuilder

com.google.protobuf.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;

hasTimeout

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:: Whether the timeout field is set.

getTimeout

com.google.protobuf.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:: The timeout.

getTimeoutOrBuilder

com.google.protobuf.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;

getContentMatchersList

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;

getContentMatchers

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;

getContentMatchersCount

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;

getContentMatchersOrBuilderList

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;

getContentMatchersOrBuilder

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;

getCheckerTypeValue
```
int getCheckerTypeValue()
```
```
 The type of checkers to use to execute the Uptime check.
 
```
.google.monitoring.v3.UptimeCheckConfig.CheckerType checker_type = 17;
Returns:

The enum numeric value on the wire for checkerType.

getCheckerType

UptimeCheckConfig.CheckerType getCheckerType()

 The type of checkers to use to execute the Uptime check.

.google.monitoring.v3.UptimeCheckConfig.CheckerType checker_type = 17;

Returns:: The checkerType.

getSelectedRegionsList

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:: A list containing the selectedRegions.

getSelectedRegionsCount

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:: The count of selectedRegions.

getSelectedRegions

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;

Parameters:: index - The index of the element to return.
Returns:: The selectedRegions at the given index.

getSelectedRegionsValueList

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:: A list containing the enum numeric values on the wire for selectedRegions.

getSelectedRegionsValue

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;

Parameters:: index - The index of the value to return.
Returns:: The enum numeric value on the wire of selectedRegions at the given index.

getIsInternal

@Deprecated
boolean getIsInternal()

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

 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:: The isInternal.

getInternalCheckersList

@Deprecated
List<InternalChecker> getInternalCheckersList()

Deprecated.

 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];

getInternalCheckers

@Deprecated
InternalChecker getInternalCheckers(int index)

Deprecated.

 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];

getInternalCheckersCount

@Deprecated
int getInternalCheckersCount()

Deprecated.

 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];

getInternalCheckersOrBuilderList

@Deprecated
List<? extends InternalCheckerOrBuilder> getInternalCheckersOrBuilderList()

Deprecated.

 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];

getInternalCheckersOrBuilder

@Deprecated
InternalCheckerOrBuilder getInternalCheckersOrBuilder(int index)

Deprecated.

 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];