Class MonitoringConfig (1.42.0)

public final class MonitoringConfig extends GeneratedMessageV3 implements MonitoringConfigOrBuilder

This field informs Fleet-based applications/services/UIs with the necessary information for where each underlying Cluster reports its metrics.

Protobuf type google.cloud.gkehub.v1.MonitoringConfig

Static Fields

CLUSTER_FIELD_NUMBER

public static final int CLUSTER_FIELD_NUMBER
Field Value
Type Description
int

CLUSTER_HASH_FIELD_NUMBER

public static final int CLUSTER_HASH_FIELD_NUMBER
Field Value
Type Description
int

KUBERNETES_METRICS_PREFIX_FIELD_NUMBER

public static final int KUBERNETES_METRICS_PREFIX_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MonitoringConfig getDefaultInstance()
Returns
Type Description
MonitoringConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static MonitoringConfig.Builder newBuilder()
Returns
Type Description
MonitoringConfig.Builder

newBuilder(MonitoringConfig prototype)

public static MonitoringConfig.Builder newBuilder(MonitoringConfig prototype)
Parameter
Name Description
prototype MonitoringConfig
Returns
Type Description
MonitoringConfig.Builder

parseDelimitedFrom(InputStream input)

public static MonitoringConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MonitoringConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MonitoringConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MonitoringConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static MonitoringConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
MonitoringConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MonitoringConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MonitoringConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MonitoringConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
MonitoringConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MonitoringConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MonitoringConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MonitoringConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
MonitoringConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MonitoringConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MonitoringConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static MonitoringConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MonitoringConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MonitoringConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MonitoringConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static MonitoringConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
MonitoringConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MonitoringConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MonitoringConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<MonitoringConfig> parser()
Returns
Type Description
Parser<MonitoringConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCluster()

public String getCluster()

Immutable. Cluster name used to report metrics. For Anthos on VMWare/Baremetal, it would be in format memberClusters/cluster_name; And for Anthos on MultiCloud, it would be in format {azureClusters, awsClusters}/cluster_name.

string cluster = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The cluster.

getClusterBytes()

public ByteString getClusterBytes()

Immutable. Cluster name used to report metrics. For Anthos on VMWare/Baremetal, it would be in format memberClusters/cluster_name; And for Anthos on MultiCloud, it would be in format {azureClusters, awsClusters}/cluster_name.

string cluster = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for cluster.

getClusterHash()

public String getClusterHash()

Immutable. Cluster hash, this is a unique string generated by google code, which does not contain any PII, which we can use to reference the cluster. This is expected to be created by the monitoring stack and persisted into the Cluster object as well as to GKE-Hub.

string cluster_hash = 5 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The clusterHash.

getClusterHashBytes()

public ByteString getClusterHashBytes()

Immutable. Cluster hash, this is a unique string generated by google code, which does not contain any PII, which we can use to reference the cluster. This is expected to be created by the monitoring stack and persisted into the Cluster object as well as to GKE-Hub.

string cluster_hash = 5 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for clusterHash.

getDefaultInstanceForType()

public MonitoringConfig getDefaultInstanceForType()
Returns
Type Description
MonitoringConfig

getKubernetesMetricsPrefix()

public String getKubernetesMetricsPrefix()

Kubernetes system metrics, if available, are written to this prefix. This defaults to kubernetes.io for GKE, and kubernetes.io/anthos for Anthos eventually. Noted: Anthos MultiCloud will have kubernetes.io prefix today but will migration to be under kubernetes.io/anthos

string kubernetes_metrics_prefix = 4;

Returns
Type Description
String

The kubernetesMetricsPrefix.

getKubernetesMetricsPrefixBytes()

public ByteString getKubernetesMetricsPrefixBytes()

Kubernetes system metrics, if available, are written to this prefix. This defaults to kubernetes.io for GKE, and kubernetes.io/anthos for Anthos eventually. Noted: Anthos MultiCloud will have kubernetes.io prefix today but will migration to be under kubernetes.io/anthos

string kubernetes_metrics_prefix = 4;

Returns
Type Description
ByteString

The bytes for kubernetesMetricsPrefix.

getLocation()

public String getLocation()

Immutable. Location used to report Metrics

string location = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The location.

getLocationBytes()

public ByteString getLocationBytes()

Immutable. Location used to report Metrics

string location = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for location.

getParserForType()

public Parser<MonitoringConfig> getParserForType()
Returns
Type Description
Parser<MonitoringConfig>
Overrides

getProjectId()

public String getProjectId()

Immutable. Project used to report Metrics

string project_id = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

Immutable. Project used to report Metrics

string project_id = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for projectId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public MonitoringConfig.Builder newBuilderForType()
Returns
Type Description
MonitoringConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MonitoringConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
MonitoringConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public MonitoringConfig.Builder toBuilder()
Returns
Type Description
MonitoringConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException