public static final class UptimeCheckConfig.Builder extends GeneratedMessageV3.Builder<UptimeCheckConfig.Builder> implements UptimeCheckConfigOrBuilderThis message configures which resources and services to monitor for availability.
Protobuf type google.monitoring.v3.UptimeCheckConfig
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > UptimeCheckConfig.BuilderImplements
UptimeCheckConfigOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllContentMatchers(Iterable<? extends UptimeCheckConfig.ContentMatcher> values)
public UptimeCheckConfig.Builder addAllContentMatchers(Iterable<? extends UptimeCheckConfig.ContentMatcher> values) 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 |
values |
Iterable<? extends com.google.monitoring.v3.UptimeCheckConfig.ContentMatcher> |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
addAllInternalCheckers(Iterable<? extends InternalChecker> values) (deprecated)
public UptimeCheckConfig.Builder addAllInternalCheckers(Iterable<? extends InternalChecker> values) 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 |
values |
Iterable<? extends com.google.monitoring.v3.InternalChecker> |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
addAllSelectedRegions(Iterable<? extends UptimeCheckRegion> values)
public UptimeCheckConfig.Builder addAllSelectedRegions(Iterable<? extends UptimeCheckRegion> values)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 |
values |
Iterable<? extends com.google.monitoring.v3.UptimeCheckRegion>The selectedRegions to add. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
This builder for chaining. |
addAllSelectedRegionsValue(Iterable<Integer> values)
public UptimeCheckConfig.Builder addAllSelectedRegionsValue(Iterable<Integer> values)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 |
values |
Iterable<Integer>The enum numeric values on the wire for selectedRegions to add. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
This builder for chaining. |
addContentMatchers(UptimeCheckConfig.ContentMatcher value)
public UptimeCheckConfig.Builder addContentMatchers(UptimeCheckConfig.ContentMatcher value) 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 |
value |
UptimeCheckConfig.ContentMatcher |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
addContentMatchers(UptimeCheckConfig.ContentMatcher.Builder builderForValue)
public UptimeCheckConfig.Builder addContentMatchers(UptimeCheckConfig.ContentMatcher.Builder builderForValue) 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 |
builderForValue |
UptimeCheckConfig.ContentMatcher.Builder |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
addContentMatchers(int index, UptimeCheckConfig.ContentMatcher value)
public UptimeCheckConfig.Builder addContentMatchers(int index, UptimeCheckConfig.ContentMatcher value) 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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
UptimeCheckConfig.ContentMatcher |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
addContentMatchers(int index, UptimeCheckConfig.ContentMatcher.Builder builderForValue)
public UptimeCheckConfig.Builder addContentMatchers(int index, UptimeCheckConfig.ContentMatcher.Builder builderForValue) 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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
UptimeCheckConfig.ContentMatcher.Builder |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
addContentMatchersBuilder()
public UptimeCheckConfig.ContentMatcher.Builder addContentMatchersBuilder() 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 |
UptimeCheckConfig.ContentMatcher.Builder |
|
addContentMatchersBuilder(int index)
public UptimeCheckConfig.ContentMatcher.Builder addContentMatchersBuilder(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.Builder |
|
addInternalCheckers(InternalChecker value) (deprecated)
public UptimeCheckConfig.Builder addInternalCheckers(InternalChecker value) 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 |
value |
InternalChecker |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
addInternalCheckers(InternalChecker.Builder builderForValue) (deprecated)
public UptimeCheckConfig.Builder addInternalCheckers(InternalChecker.Builder builderForValue) 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 |
builderForValue |
InternalChecker.Builder |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
addInternalCheckers(int index, InternalChecker value) (deprecated)
public UptimeCheckConfig.Builder addInternalCheckers(int index, InternalChecker value) 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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
InternalChecker |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
addInternalCheckers(int index, InternalChecker.Builder builderForValue) (deprecated)
public UptimeCheckConfig.Builder addInternalCheckers(int index, InternalChecker.Builder builderForValue) 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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
InternalChecker.Builder |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
addInternalCheckersBuilder() (deprecated)
public InternalChecker.Builder addInternalCheckersBuilder() 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 |
InternalChecker.Builder |
|
addInternalCheckersBuilder(int index) (deprecated)
public InternalChecker.Builder addInternalCheckersBuilder(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.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public UptimeCheckConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
addSelectedRegions(UptimeCheckRegion value)
public UptimeCheckConfig.Builder addSelectedRegions(UptimeCheckRegion value)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 |
value |
UptimeCheckRegionThe selectedRegions to add. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
This builder for chaining. |
addSelectedRegionsValue(int value)
public UptimeCheckConfig.Builder addSelectedRegionsValue(int value)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 |
value |
intThe enum numeric value on the wire for selectedRegions to add. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
This builder for chaining. |
build()
public UptimeCheckConfig build()| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig |
|
buildPartial()
public UptimeCheckConfig buildPartial()| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig |
|
clear()
public UptimeCheckConfig.Builder clear()| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
clearCheckRequestType()
public UptimeCheckConfig.Builder clearCheckRequestType()| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
clearCheckerType()
public UptimeCheckConfig.Builder clearCheckerType()The type of checkers to use to execute the Uptime check.
.google.monitoring.v3.UptimeCheckConfig.CheckerType checker_type = 17;
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
This builder for chaining. |
clearContentMatchers()
public UptimeCheckConfig.Builder clearContentMatchers() 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 |
UptimeCheckConfig.Builder |
|
clearDisplayName()
public UptimeCheckConfig.Builder clearDisplayName()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 | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public UptimeCheckConfig.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
clearHttpCheck()
public UptimeCheckConfig.Builder clearHttpCheck()Contains information needed to make an HTTP or HTTPS check.
.google.monitoring.v3.UptimeCheckConfig.HttpCheck http_check = 5;
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
clearInternalCheckers() (deprecated)
public UptimeCheckConfig.Builder clearInternalCheckers() 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 |
UptimeCheckConfig.Builder |
|
clearIsInternal() (deprecated)
public UptimeCheckConfig.Builder clearIsInternal()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 | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
This builder for chaining. |
clearMonitoredResource()
public UptimeCheckConfig.Builder clearMonitoredResource() 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
servicedirectory_service
cloud_run_revision
.google.api.MonitoredResource monitored_resource = 3;
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
clearName()
public UptimeCheckConfig.Builder clearName()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 | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public UptimeCheckConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
clearPeriod()
public UptimeCheckConfig.Builder clearPeriod() 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 |
UptimeCheckConfig.Builder |
|
clearResource()
public UptimeCheckConfig.Builder clearResource()| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
clearResourceGroup()
public UptimeCheckConfig.Builder clearResourceGroup()The group resource associated with the configuration.
.google.monitoring.v3.UptimeCheckConfig.ResourceGroup resource_group = 4;
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
clearSelectedRegions()
public UptimeCheckConfig.Builder clearSelectedRegions()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 |
UptimeCheckConfig.Builder |
This builder for chaining. |
clearSyntheticMonitor()
public UptimeCheckConfig.Builder clearSyntheticMonitor()Specifies a Synthetic Monitor to invoke.
.google.monitoring.v3.SyntheticMonitorTarget synthetic_monitor = 21;
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
clearTcpCheck()
public UptimeCheckConfig.Builder clearTcpCheck()Contains information needed to make a TCP check.
.google.monitoring.v3.UptimeCheckConfig.TcpCheck tcp_check = 6;
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
clearTimeout()
public UptimeCheckConfig.Builder clearTimeout()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 |
UptimeCheckConfig.Builder |
|
clearUserLabels()
public UptimeCheckConfig.Builder clearUserLabels()| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
clone()
public UptimeCheckConfig.Builder clone()| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
containsUserLabels(String key)
public boolean containsUserLabels(String key) User-supplied key/value data to be used for organizing and
identifying the UptimeCheckConfig objects.
The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.
map<string, string> user_labels = 20;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getCheckRequestTypeCase()
public UptimeCheckConfig.CheckRequestTypeCase getCheckRequestTypeCase()| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.CheckRequestTypeCase |
|
getCheckerType()
public UptimeCheckConfig.CheckerType getCheckerType()The type of checkers to use to execute the Uptime check.
.google.monitoring.v3.UptimeCheckConfig.CheckerType checker_type = 17;
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.CheckerType |
The checkerType. |
getCheckerTypeValue()
public int getCheckerTypeValue()The type of checkers to use to execute the Uptime check.
.google.monitoring.v3.UptimeCheckConfig.CheckerType checker_type = 17;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for checkerType. |
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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.ContentMatcher |
|
getContentMatchersBuilder(int index)
public UptimeCheckConfig.ContentMatcher.Builder getContentMatchersBuilder(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.Builder |
|
getContentMatchersBuilderList()
public List<UptimeCheckConfig.ContentMatcher.Builder> getContentMatchersBuilderList() 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<Builder> |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
List<? extends com.google.monitoring.v3.UptimeCheckConfig.ContentMatcherOrBuilder> |
|
getDefaultInstanceForType()
public UptimeCheckConfig getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDisplayName()
public 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 | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public 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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck |
The httpCheck. |
getHttpCheckBuilder()
public UptimeCheckConfig.HttpCheck.Builder getHttpCheckBuilder()Contains information needed to make an HTTP or HTTPS check.
.google.monitoring.v3.UptimeCheckConfig.HttpCheck http_check = 5;
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
getHttpCheckOrBuilder()
public 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) (deprecated)
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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
InternalChecker |
|
getInternalCheckersBuilder(int index) (deprecated)
public InternalChecker.Builder getInternalCheckersBuilder(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.Builder |
|
getInternalCheckersBuilderList() (deprecated)
public List<InternalChecker.Builder> getInternalCheckersBuilderList() 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<Builder> |
|
getInternalCheckersCount() (deprecated)
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 | |
|---|---|
| Type | Description |
int |
|
getInternalCheckersList() (deprecated)
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 | |
|---|---|
| Type | Description |
List<InternalChecker> |
|
getInternalCheckersOrBuilder(int index) (deprecated)
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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
InternalCheckerOrBuilder |
|
getInternalCheckersOrBuilderList() (deprecated)
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 | |
|---|---|
| Type | Description |
List<? extends com.google.monitoring.v3.InternalCheckerOrBuilder> |
|
getIsInternal() (deprecated)
public 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 | |
|---|---|
| Type | Description |
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
servicedirectory_service
cloud_run_revision
.google.api.MonitoredResource monitored_resource = 3;
| Returns | |
|---|---|
| Type | Description |
com.google.api.MonitoredResource |
The monitoredResource. |
getMonitoredResourceBuilder()
public MonitoredResource.Builder getMonitoredResourceBuilder() 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
servicedirectory_service
cloud_run_revision
.google.api.MonitoredResource monitored_resource = 3;
| Returns | |
|---|---|
| Type | Description |
com.google.api.MonitoredResource.Builder |
|
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
servicedirectory_service
cloud_run_revision
.google.api.MonitoredResource monitored_resource = 3;
| Returns | |
|---|---|
| Type | Description |
com.google.api.MonitoredResourceOrBuilder |
|
getMutableUserLabels() (deprecated)
public Map<String,String> getMutableUserLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getName()
public 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 | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
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 | |
|---|---|
| Type | Description |
Duration |
The period. |
getPeriodBuilder()
public Duration.Builder getPeriodBuilder() 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 |
Builder |
|
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 | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getResourceCase()
public UptimeCheckConfig.ResourceCase getResourceCase()| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.ResourceCase |
|
getResourceGroup()
public 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. |
getResourceGroupBuilder()
public UptimeCheckConfig.ResourceGroup.Builder getResourceGroupBuilder()The group resource associated with the configuration.
.google.monitoring.v3.UptimeCheckConfig.ResourceGroup resource_group = 4;
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.ResourceGroup.Builder |
|
getResourceGroupOrBuilder()
public 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 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 |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
intThe 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 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. |
getSyntheticMonitor()
public SyntheticMonitorTarget getSyntheticMonitor()Specifies a Synthetic Monitor to invoke.
.google.monitoring.v3.SyntheticMonitorTarget synthetic_monitor = 21;
| Returns | |
|---|---|
| Type | Description |
SyntheticMonitorTarget |
The syntheticMonitor. |
getSyntheticMonitorBuilder()
public SyntheticMonitorTarget.Builder getSyntheticMonitorBuilder()Specifies a Synthetic Monitor to invoke.
.google.monitoring.v3.SyntheticMonitorTarget synthetic_monitor = 21;
| Returns | |
|---|---|
| Type | Description |
SyntheticMonitorTarget.Builder |
|
getSyntheticMonitorOrBuilder()
public SyntheticMonitorTargetOrBuilder getSyntheticMonitorOrBuilder()Specifies a Synthetic Monitor to invoke.
.google.monitoring.v3.SyntheticMonitorTarget synthetic_monitor = 21;
| Returns | |
|---|---|
| Type | Description |
SyntheticMonitorTargetOrBuilder |
|
getTcpCheck()
public 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. |
getTcpCheckBuilder()
public UptimeCheckConfig.TcpCheck.Builder getTcpCheckBuilder()Contains information needed to make a TCP check.
.google.monitoring.v3.UptimeCheckConfig.TcpCheck tcp_check = 6;
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.TcpCheck.Builder |
|
getTcpCheckOrBuilder()
public 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 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. |
getTimeoutBuilder()
public Duration.Builder getTimeoutBuilder()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 |
Builder |
|
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 | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getUserLabels() (deprecated)
public Map<String,String> getUserLabels()Use #getUserLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getUserLabelsCount()
public int getUserLabelsCount() User-supplied key/value data to be used for organizing and
identifying the UptimeCheckConfig objects.
The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.
map<string, string> user_labels = 20;
| Returns | |
|---|---|
| Type | Description |
int |
|
getUserLabelsMap()
public Map<String,String> getUserLabelsMap() User-supplied key/value data to be used for organizing and
identifying the UptimeCheckConfig objects.
The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.
map<string, string> user_labels = 20;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getUserLabelsOrDefault(String key, String defaultValue)
public String getUserLabelsOrDefault(String key, String defaultValue) User-supplied key/value data to be used for organizing and
identifying the UptimeCheckConfig objects.
The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.
map<string, string> user_labels = 20;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getUserLabelsOrThrow(String key)
public String getUserLabelsOrThrow(String key) User-supplied key/value data to be used for organizing and
identifying the UptimeCheckConfig objects.
The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.
map<string, string> user_labels = 20;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
hasHttpCheck()
public 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 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
servicedirectory_service
cloud_run_revision
.google.api.MonitoredResource monitored_resource = 3;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean |
Whether the resourceGroup field is set. |
hasSyntheticMonitor()
public boolean hasSyntheticMonitor()Specifies a Synthetic Monitor to invoke.
.google.monitoring.v3.SyntheticMonitorTarget synthetic_monitor = 21;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the syntheticMonitor field is set. |
hasTcpCheck()
public 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(UptimeCheckConfig other)
public UptimeCheckConfig.Builder mergeFrom(UptimeCheckConfig other)| Parameter | |
|---|---|
| Name | Description |
other |
UptimeCheckConfig |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public UptimeCheckConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public UptimeCheckConfig.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
mergeHttpCheck(UptimeCheckConfig.HttpCheck value)
public UptimeCheckConfig.Builder mergeHttpCheck(UptimeCheckConfig.HttpCheck value)Contains information needed to make an HTTP or HTTPS check.
.google.monitoring.v3.UptimeCheckConfig.HttpCheck http_check = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
UptimeCheckConfig.HttpCheck |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
mergeMonitoredResource(MonitoredResource value)
public UptimeCheckConfig.Builder mergeMonitoredResource(MonitoredResource value) 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
servicedirectory_service
cloud_run_revision
.google.api.MonitoredResource monitored_resource = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.api.MonitoredResource |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
mergePeriod(Duration value)
public UptimeCheckConfig.Builder mergePeriod(Duration value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
mergeResourceGroup(UptimeCheckConfig.ResourceGroup value)
public UptimeCheckConfig.Builder mergeResourceGroup(UptimeCheckConfig.ResourceGroup value)The group resource associated with the configuration.
.google.monitoring.v3.UptimeCheckConfig.ResourceGroup resource_group = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
UptimeCheckConfig.ResourceGroup |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
mergeSyntheticMonitor(SyntheticMonitorTarget value)
public UptimeCheckConfig.Builder mergeSyntheticMonitor(SyntheticMonitorTarget value)Specifies a Synthetic Monitor to invoke.
.google.monitoring.v3.SyntheticMonitorTarget synthetic_monitor = 21;
| Parameter | |
|---|---|
| Name | Description |
value |
SyntheticMonitorTarget |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
mergeTcpCheck(UptimeCheckConfig.TcpCheck value)
public UptimeCheckConfig.Builder mergeTcpCheck(UptimeCheckConfig.TcpCheck value)Contains information needed to make a TCP check.
.google.monitoring.v3.UptimeCheckConfig.TcpCheck tcp_check = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
UptimeCheckConfig.TcpCheck |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
mergeTimeout(Duration value)
public UptimeCheckConfig.Builder mergeTimeout(Duration value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final UptimeCheckConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
putAllUserLabels(Map<String,String> values)
public UptimeCheckConfig.Builder putAllUserLabels(Map<String,String> values) User-supplied key/value data to be used for organizing and
identifying the UptimeCheckConfig objects.
The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.
map<string, string> user_labels = 20;
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
putUserLabels(String key, String value)
public UptimeCheckConfig.Builder putUserLabels(String key, String value) User-supplied key/value data to be used for organizing and
identifying the UptimeCheckConfig objects.
The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.
map<string, string> user_labels = 20;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
String |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
removeContentMatchers(int index)
public UptimeCheckConfig.Builder removeContentMatchers(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.Builder |
|
removeInternalCheckers(int index) (deprecated)
public UptimeCheckConfig.Builder removeInternalCheckers(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 |
UptimeCheckConfig.Builder |
|
removeUserLabels(String key)
public UptimeCheckConfig.Builder removeUserLabels(String key) User-supplied key/value data to be used for organizing and
identifying the UptimeCheckConfig objects.
The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.
map<string, string> user_labels = 20;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
setCheckerType(UptimeCheckConfig.CheckerType value)
public UptimeCheckConfig.Builder setCheckerType(UptimeCheckConfig.CheckerType value)The type of checkers to use to execute the Uptime check.
.google.monitoring.v3.UptimeCheckConfig.CheckerType checker_type = 17;
| Parameter | |
|---|---|
| Name | Description |
value |
UptimeCheckConfig.CheckerTypeThe checkerType to set. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
This builder for chaining. |
setCheckerTypeValue(int value)
public UptimeCheckConfig.Builder setCheckerTypeValue(int value)The type of checkers to use to execute the Uptime check.
.google.monitoring.v3.UptimeCheckConfig.CheckerType checker_type = 17;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for checkerType to set. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
This builder for chaining. |
setContentMatchers(int index, UptimeCheckConfig.ContentMatcher value)
public UptimeCheckConfig.Builder setContentMatchers(int index, UptimeCheckConfig.ContentMatcher value) 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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
UptimeCheckConfig.ContentMatcher |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
setContentMatchers(int index, UptimeCheckConfig.ContentMatcher.Builder builderForValue)
public UptimeCheckConfig.Builder setContentMatchers(int index, UptimeCheckConfig.ContentMatcher.Builder builderForValue) 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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
UptimeCheckConfig.ContentMatcher.Builder |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
setDisplayName(String value)
public UptimeCheckConfig.Builder setDisplayName(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public UptimeCheckConfig.Builder setDisplayNameBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public UptimeCheckConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
setHttpCheck(UptimeCheckConfig.HttpCheck value)
public UptimeCheckConfig.Builder setHttpCheck(UptimeCheckConfig.HttpCheck value)Contains information needed to make an HTTP or HTTPS check.
.google.monitoring.v3.UptimeCheckConfig.HttpCheck http_check = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
UptimeCheckConfig.HttpCheck |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
setHttpCheck(UptimeCheckConfig.HttpCheck.Builder builderForValue)
public UptimeCheckConfig.Builder setHttpCheck(UptimeCheckConfig.HttpCheck.Builder builderForValue)Contains information needed to make an HTTP or HTTPS check.
.google.monitoring.v3.UptimeCheckConfig.HttpCheck http_check = 5;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
UptimeCheckConfig.HttpCheck.Builder |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
setInternalCheckers(int index, InternalChecker value) (deprecated)
public UptimeCheckConfig.Builder setInternalCheckers(int index, InternalChecker value) 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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
InternalChecker |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
setInternalCheckers(int index, InternalChecker.Builder builderForValue) (deprecated)
public UptimeCheckConfig.Builder setInternalCheckers(int index, InternalChecker.Builder builderForValue) 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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
InternalChecker.Builder |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
setIsInternal(boolean value) (deprecated)
public UptimeCheckConfig.Builder setIsInternal(boolean value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe isInternal to set. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
This builder for chaining. |
setMonitoredResource(MonitoredResource value)
public UptimeCheckConfig.Builder setMonitoredResource(MonitoredResource value) 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
servicedirectory_service
cloud_run_revision
.google.api.MonitoredResource monitored_resource = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.api.MonitoredResource |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
setMonitoredResource(MonitoredResource.Builder builderForValue)
public UptimeCheckConfig.Builder setMonitoredResource(MonitoredResource.Builder builderForValue) 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
servicedirectory_service
cloud_run_revision
.google.api.MonitoredResource monitored_resource = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
com.google.api.MonitoredResource.Builder |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
setName(String value)
public UptimeCheckConfig.Builder setName(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public UptimeCheckConfig.Builder setNameBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
This builder for chaining. |
setPeriod(Duration value)
public UptimeCheckConfig.Builder setPeriod(Duration value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
setPeriod(Duration.Builder builderForValue)
public UptimeCheckConfig.Builder setPeriod(Duration.Builder builderForValue) 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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public UptimeCheckConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
setResourceGroup(UptimeCheckConfig.ResourceGroup value)
public UptimeCheckConfig.Builder setResourceGroup(UptimeCheckConfig.ResourceGroup value)The group resource associated with the configuration.
.google.monitoring.v3.UptimeCheckConfig.ResourceGroup resource_group = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
UptimeCheckConfig.ResourceGroup |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
setResourceGroup(UptimeCheckConfig.ResourceGroup.Builder builderForValue)
public UptimeCheckConfig.Builder setResourceGroup(UptimeCheckConfig.ResourceGroup.Builder builderForValue)The group resource associated with the configuration.
.google.monitoring.v3.UptimeCheckConfig.ResourceGroup resource_group = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
UptimeCheckConfig.ResourceGroup.Builder |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
setSelectedRegions(int index, UptimeCheckRegion value)
public UptimeCheckConfig.Builder setSelectedRegions(int index, UptimeCheckRegion value)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 | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
UptimeCheckRegionThe selectedRegions to set. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
This builder for chaining. |
setSelectedRegionsValue(int index, int value)
public UptimeCheckConfig.Builder setSelectedRegionsValue(int index, int value)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 | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
intThe enum numeric value on the wire for selectedRegions to set. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
This builder for chaining. |
setSyntheticMonitor(SyntheticMonitorTarget value)
public UptimeCheckConfig.Builder setSyntheticMonitor(SyntheticMonitorTarget value)Specifies a Synthetic Monitor to invoke.
.google.monitoring.v3.SyntheticMonitorTarget synthetic_monitor = 21;
| Parameter | |
|---|---|
| Name | Description |
value |
SyntheticMonitorTarget |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
setSyntheticMonitor(SyntheticMonitorTarget.Builder builderForValue)
public UptimeCheckConfig.Builder setSyntheticMonitor(SyntheticMonitorTarget.Builder builderForValue)Specifies a Synthetic Monitor to invoke.
.google.monitoring.v3.SyntheticMonitorTarget synthetic_monitor = 21;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SyntheticMonitorTarget.Builder |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
setTcpCheck(UptimeCheckConfig.TcpCheck value)
public UptimeCheckConfig.Builder setTcpCheck(UptimeCheckConfig.TcpCheck value)Contains information needed to make a TCP check.
.google.monitoring.v3.UptimeCheckConfig.TcpCheck tcp_check = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
UptimeCheckConfig.TcpCheck |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
setTcpCheck(UptimeCheckConfig.TcpCheck.Builder builderForValue)
public UptimeCheckConfig.Builder setTcpCheck(UptimeCheckConfig.TcpCheck.Builder builderForValue)Contains information needed to make a TCP check.
.google.monitoring.v3.UptimeCheckConfig.TcpCheck tcp_check = 6;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
UptimeCheckConfig.TcpCheck.Builder |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
setTimeout(Duration value)
public UptimeCheckConfig.Builder setTimeout(Duration value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
setTimeout(Duration.Builder builderForValue)
public UptimeCheckConfig.Builder setTimeout(Duration.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final UptimeCheckConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.Builder |
|