public final class UptimeCheckConfig extends GeneratedMessageV3 implements UptimeCheckConfigOrBuilder
This message configures which resources and services to monitor for
availability.
Protobuf type google.monitoring.v3.UptimeCheckConfig
Static Fields
CHECKER_TYPE_FIELD_NUMBER
public static final int CHECKER_TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CONTENT_MATCHERS_FIELD_NUMBER
public static final int CONTENT_MATCHERS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
HTTP_CHECK_FIELD_NUMBER
public static final int HTTP_CHECK_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
INTERNAL_CHECKERS_FIELD_NUMBER
public static final int INTERNAL_CHECKERS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
IS_INTERNAL_FIELD_NUMBER
public static final int IS_INTERNAL_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MONITORED_RESOURCE_FIELD_NUMBER
public static final int MONITORED_RESOURCE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PERIOD_FIELD_NUMBER
public static final int PERIOD_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RESOURCE_GROUP_FIELD_NUMBER
public static final int RESOURCE_GROUP_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SELECTED_REGIONS_FIELD_NUMBER
public static final int SELECTED_REGIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TCP_CHECK_FIELD_NUMBER
public static final int TCP_CHECK_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TIMEOUT_FIELD_NUMBER
public static final int TIMEOUT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
USER_LABELS_FIELD_NUMBER
public static final int USER_LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static UptimeCheckConfig getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static UptimeCheckConfig.Builder newBuilder()
newBuilder(UptimeCheckConfig prototype)
public static UptimeCheckConfig.Builder newBuilder(UptimeCheckConfig prototype)
public static UptimeCheckConfig parseDelimitedFrom(InputStream input)
public static UptimeCheckConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static UptimeCheckConfig parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static UptimeCheckConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static UptimeCheckConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UptimeCheckConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UptimeCheckConfig parseFrom(CodedInputStream input)
public static UptimeCheckConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static UptimeCheckConfig parseFrom(InputStream input)
public static UptimeCheckConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static UptimeCheckConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static UptimeCheckConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<UptimeCheckConfig> parser()
Methods
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getCheckRequestTypeCase()
public UptimeCheckConfig.CheckRequestTypeCase getCheckRequestTypeCase()
getCheckerType()
public UptimeCheckConfig.CheckerType getCheckerType()
The type of checkers to use to execute the Uptime check.
.google.monitoring.v3.UptimeCheckConfig.CheckerType checker_type = 17;
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
|
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;
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
|
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()
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;
getHttpCheckOrBuilder()
public UptimeCheckConfig.HttpCheckOrBuilder getHttpCheckOrBuilder()
Contains information needed to make an HTTP or HTTPS check.
.google.monitoring.v3.UptimeCheckConfig.HttpCheck http_check = 5;
getInternalCheckers(int index)
public InternalChecker getInternalCheckers(int index)
The internal checkers that this check will egress from. If is_internal is
true and this list is empty, the check will egress from all the
InternalCheckers configured for the project that owns this
UptimeCheckConfig.
repeated .google.monitoring.v3.InternalChecker internal_checkers = 14 [deprecated = true];
| Parameter |
|---|
| Name | Description |
index | int
|
getInternalCheckersCount()
public int getInternalCheckersCount()
The internal checkers that this check will egress from. If is_internal is
true and this list is empty, the check will egress from all the
InternalCheckers configured for the project that owns this
UptimeCheckConfig.
repeated .google.monitoring.v3.InternalChecker internal_checkers = 14 [deprecated = true];
| Returns |
|---|
| Type | Description |
int | |
getInternalCheckersList()
public List<InternalChecker> getInternalCheckersList()
The internal checkers that this check will egress from. If is_internal is
true and this list is empty, the check will egress from all the
InternalCheckers configured for the project that owns this
UptimeCheckConfig.
repeated .google.monitoring.v3.InternalChecker internal_checkers = 14 [deprecated = true];
getInternalCheckersOrBuilder(int index)
public InternalCheckerOrBuilder getInternalCheckersOrBuilder(int index)
The internal checkers that this check will egress from. If is_internal is
true and this list is empty, the check will egress from all the
InternalCheckers configured for the project that owns this
UptimeCheckConfig.
repeated .google.monitoring.v3.InternalChecker internal_checkers = 14 [deprecated = true];
| Parameter |
|---|
| Name | Description |
index | int
|
getInternalCheckersOrBuilderList()
public List<? extends InternalCheckerOrBuilder> getInternalCheckersOrBuilderList()
The internal checkers that this check will egress from. If is_internal is
true and this list is empty, the check will egress from all the
InternalCheckers configured for the project that owns this
UptimeCheckConfig.
repeated .google.monitoring.v3.InternalChecker internal_checkers = 14 [deprecated = true];
| Returns |
|---|
| 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=478
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.
|
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 | |
getName()
A unique resource name for this Uptime check configuration. The format is:
projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
[PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the
Uptime check.
This field should be omitted when creating the Uptime check configuration;
on create, the resource name is assigned by the server and included in the
response.
string name = 1;
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
A unique resource name for this Uptime check configuration. The format is:
projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
[PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the
Uptime check.
This field should be omitted when creating the Uptime check configuration;
on create, the resource name is assigned by the server and included in the
response.
string name = 1;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<UptimeCheckConfig> getParserForType()
Overrides
getPeriod()
public Duration getPeriod()
How often, in seconds, the Uptime check is performed.
Currently, the only supported values are 60s (1 minute), 300s
(5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional,
defaults to 60s.
.google.protobuf.Duration period = 7;
| Returns |
|---|
| Type | Description |
Duration | The period.
|
getPeriodOrBuilder()
public DurationOrBuilder getPeriodOrBuilder()
How often, in seconds, the Uptime check is performed.
Currently, the only supported values are 60s (1 minute), 300s
(5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional,
defaults to 60s.
.google.protobuf.Duration period = 7;
getResourceCase()
public UptimeCheckConfig.ResourceCase getResourceCase()
getResourceGroup()
public UptimeCheckConfig.ResourceGroup getResourceGroup()
The group resource associated with the configuration.
.google.monitoring.v3.UptimeCheckConfig.ResourceGroup resource_group = 4;
getResourceGroupOrBuilder()
public UptimeCheckConfig.ResourceGroupOrBuilder getResourceGroupOrBuilder()
The group resource associated with the configuration.
.google.monitoring.v3.UptimeCheckConfig.ResourceGroup resource_group = 4;
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 | int
The index of the element to return.
|
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;
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 | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire of selectedRegions at the given index.
|
getSelectedRegionsValueList()
public 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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getTcpCheck()
public UptimeCheckConfig.TcpCheck getTcpCheck()
Contains information needed to make a TCP check.
.google.monitoring.v3.UptimeCheckConfig.TcpCheck tcp_check = 6;
getTcpCheckOrBuilder()
public UptimeCheckConfig.TcpCheckOrBuilder getTcpCheckOrBuilder()
Contains information needed to make a TCP check.
.google.monitoring.v3.UptimeCheckConfig.TcpCheck tcp_check = 6;
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.
|
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;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUserLabels()
public Map<String,String> getUserLabels()
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;
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;
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
|
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.
|
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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public UptimeCheckConfig.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected UptimeCheckConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public UptimeCheckConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
