Class MonitoringConfig (1.16.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.v1beta1.MonitoringConfig

Static Fields

CLUSTER_FIELD_NUMBER

public static final int CLUSTER_FIELD_NUMBER
Field Value
TypeDescription
int

CLUSTER_HASH_FIELD_NUMBER

public static final int CLUSTER_HASH_FIELD_NUMBER
Field Value
TypeDescription
int

KUBERNETES_METRICS_PREFIX_FIELD_NUMBER

public static final int KUBERNETES_METRICS_PREFIX_FIELD_NUMBER
Field Value
TypeDescription
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
TypeDescription
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static MonitoringConfig getDefaultInstance()
Returns
TypeDescription
MonitoringConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static MonitoringConfig.Builder newBuilder()
Returns
TypeDescription
MonitoringConfig.Builder

newBuilder(MonitoringConfig prototype)

public static MonitoringConfig.Builder newBuilder(MonitoringConfig prototype)
Parameter
NameDescription
prototypeMonitoringConfig
Returns
TypeDescription
MonitoringConfig.Builder

parseDelimitedFrom(InputStream input)

public static MonitoringConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
MonitoringConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MonitoringConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MonitoringConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static MonitoringConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
MonitoringConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MonitoringConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MonitoringConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MonitoringConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
MonitoringConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MonitoringConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MonitoringConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MonitoringConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
MonitoringConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MonitoringConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MonitoringConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static MonitoringConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
MonitoringConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MonitoringConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MonitoringConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static MonitoringConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
MonitoringConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MonitoringConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MonitoringConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<MonitoringConfig> parser()
Returns
TypeDescription
Parser<MonitoringConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for clusterHash.

getDefaultInstanceForType()

public MonitoringConfig getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for kubernetesMetricsPrefix.

getLocation()

public String getLocation()

Immutable. Location used to report Metrics

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

Returns
TypeDescription
String

The location.

getLocationBytes()

public ByteString getLocationBytes()

Immutable. Location used to report Metrics

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

Returns
TypeDescription
ByteString

The bytes for location.

getParserForType()

public Parser<MonitoringConfig> getParserForType()
Returns
TypeDescription
Parser<MonitoringConfig>
Overrides

getProjectId()

public String getProjectId()

Immutable. Project used to report Metrics

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

Returns
TypeDescription
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

Immutable. Project used to report Metrics

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

Returns
TypeDescription
ByteString

The bytes for projectId.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public MonitoringConfig.Builder newBuilderForType()
Returns
TypeDescription
MonitoringConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MonitoringConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
MonitoringConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public MonitoringConfig.Builder toBuilder()
Returns
TypeDescription
MonitoringConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException