Package com.oracle.bmc.managementagent.model

Class PrometheusEmitterDataSource

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.managementagent.model.DataSource

com.oracle.bmc.managementagent.model.PrometheusEmitterDataSource

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200202")
public final class PrometheusEmitterDataSource
extends DataSource

A Prometheus data source.
Note: Objects should always be created or deserialized using the PrometheusEmitterDataSource.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the PrometheusEmitterDataSource.Builder, which maintain a set of all explicitly set fields called PrometheusEmitterDataSource.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PrometheusEmitterDataSource.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
PrometheusEmitterDataSource(String key, String name, String compartmentId, LifecycleStates state, Date timeCreated, Date timeUpdated, String url, String namespace, String allowMetrics, String proxyUrl, Integer connectionTimeout, Integer readTimeout, Integer readDataLimit, Integer scheduleMins, String resourceGroup, List<MetricDimension> metricDimensions)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static PrometheusEmitterDataSource.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getAllowMetrics()	Comma separated metric name list.
Integer	getConnectionTimeout()	Number in milliseconds.
List<MetricDimension>	getMetricDimensions()	The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.
String	getNamespace()	The OCI monitoring namespace to which scraped metrics should be uploaded.
String	getProxyUrl()	The url of the network proxy that provides access to the Prometheus Exporter’s endpoint (url required property).
Integer	getReadDataLimit()	Number in kilobytes.
Integer	getReadTimeout()	Number in milliseconds.
String	getResourceGroup()	OCI monitoring resource group to assign the metric to.
Integer	getScheduleMins()	Number in minutes.
String	getUrl()	The url through which the Prometheus Exporter publishes its metrics.
int	hashCode()
PrometheusEmitterDataSource.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.managementagent.model.DataSource

getCompartmentId, getKey, getName, getState, getTimeCreated, getTimeUpdated

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PrometheusEmitterDataSource

@Deprecated
public PrometheusEmitterDataSource(String key,
                                   String name,
                                   String compartmentId,
                                   LifecycleStates state,
                                   Date timeCreated,
                                   Date timeUpdated,
                                   String url,
                                   String namespace,
                                   String allowMetrics,
                                   String proxyUrl,
                                   Integer connectionTimeout,
                                   Integer readTimeout,
                                   Integer readDataLimit,
                                   Integer scheduleMins,
                                   String resourceGroup,
                                   List<MetricDimension> metricDimensions)

Deprecated.

Method Detail

builder

public static PrometheusEmitterDataSource.Builder builder()

Create a new builder.

toBuilder

public PrometheusEmitterDataSource.Builder toBuilder()

getUrl

public String getUrl()

The url through which the Prometheus Exporter publishes its metrics.

(http only)

Returns:

the value

getNamespace

public String getNamespace()

The OCI monitoring namespace to which scraped metrics should be uploaded.

Returns:

the value

getAllowMetrics

public String getAllowMetrics()

Comma separated metric name list.

The complete set of desired scraped metrics. Use this property to limit the set of metrics uploaded if required.

Returns:

the value

getProxyUrl

public String getProxyUrl()

The url of the network proxy that provides access to the Prometheus Exporter’s endpoint (url required property).

Returns:

the value

getConnectionTimeout

public Integer getConnectionTimeout()

Number in milliseconds.

The timeout for connecting to the Prometheus Exporter’s endpoint.

Returns:

the value

getReadTimeout

public Integer getReadTimeout()

Number in milliseconds.

The timeout for reading the response from the Prometheus Exporter’s endpoint.

Returns:

the value

getReadDataLimit

public Integer getReadDataLimit()

Number in kilobytes.

The limit on the data being sent, not to exceed the agent’s fixed limit of 400 (KB).

Returns:

the value

getScheduleMins

public Integer getScheduleMins()

Number in minutes.

The scraping occurs at the specified interval.

Returns:

the value

getResourceGroup

public String getResourceGroup()

OCI monitoring resource group to assign the metric to.

Returns:

the value

getMetricDimensions

public List<MetricDimension> getMetricDimensions()

The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.

Returns:

the value

toString

public String toString()

Overrides:

toString in class DataSource

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class DataSource

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class DataSource

hashCode

public int hashCode()

Overrides:

hashCode in class DataSource