v2

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 1, 2022 License: Apache-2.0 Imports: 22 Imported by: 3

README

Go API client for v2

Introduction

The Confluent Cloud Metrics API provides actionable operational metrics about your Confluent Cloud deployment. This is a queryable HTTP API in which the user will POST a query written in JSON and get back a time series of metrics specified by the query.

Comprehensive documentation is available on docs.confluent.io.

Available Metrics Reference

Please see the Metrics Reference for a list of available metrics.

This information is also available programmatically via the descriptors endpoint.

Authentication

Confluent uses API keys for integrating with Confluent Cloud. Applications must be authorized and authenticated before they can access or manage resources in Confluent Cloud. You can manage your API keys in the Confluent Cloud Dashboard or Confluent Cloud CLI.

An API key is owned by a User or Service Account and inherits the permissions granted to the owner.

Today, you can divide API keys into two classes:

  • Cloud API Keys - These grant access to the Confluent Cloud Control Plane APIs, such as for Provisioning and Metrics integrations.
  • Cluster API Keys - These grant access to a single Confluent cluster, such as a specific Kafka or Schema Registry cluster.

Cloud API Keys are required for the Metrics API. Cloud API Keys can be created using the Confluent Cloud CLI.

ccloud api-key create --resource cloud

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Versioning

Confluent APIs ensure stability for your integrations by avoiding the introduction of breaking changes to customers unexpectedly. Confluent will make non-breaking API changes without advance notice. Thus, API clients must follow the Compatibility Policy below to ensure your ingtegration remains stable. All APIs follow the API Lifecycle Policy described below, which describes the guarantees API clients can rely on.

Breaking changes will be widely communicated in advance in accordance with our Deprecation Policy. Confluent will provide timelines and a migration path for all API changes, where available. Be sure to subscribe to one or more communication channels so you don't miss any updates!

One exception to these guidelines is for critical security issues. We will take any necessary actions to mitigate any critical security issue as soon as possible, which may include disabling the vulnerable functionality until a proper solution is available.

Do not consume any Confluent API unless it is documented in the API Reference. All undocumented endpoints should be considered private, subject to change without notice, and not covered by any agreements.

Note: The "v1" in the URL is not a "major version" in the Semantic Versioning sense. It is a "generational version" or "meta version", as seen in other APIs like <a href="https://developer.github.com/v3/versions/" target="_blank">Github API or the <a href="https://stripe.com/docs/api/versioning" target="_blank">Stripe API.

Changelog

2021-09-23
API Version 1 is now deprecated

All API Version 1 endpoints are now deprecated and will be removed on 2022-04-04. API users should migrate to API Version 2.

2021-08-24
Metric-specific aggregation functions

New metrics are being introduced that require alternative aggregation functions (e.g. MAX). When querying those metrics, using agg: \"SUM\" will return an error. It is recommended that clients omit the agg field in the request such that the required aggregation function for the specific metric is automatically applied on the backend.

Note: The initial version of Metrics API required clients to effectively hardcode agg: \"SUM\" in all queries. In early 2021, the agg field was made optional, but many clients have not been updated to omit the agg field.

Cursor-based pagination for /query endpoint

The /query endpoint now supports cursor-based pagination similar to the /descriptors and /attributes endpoints.

2021-02-10
API Version 2 is now Generally Available (GA)

See the Version 2 section below for a detailed description of changes and migration guide.

2020-12-04
API Version 2 (Preview)

Version 2 of the Metrics API is now available in Preview. See the Version 2 section below for a detailed description of changes.

2020-07-08
Correction for active_connection_count metric

A bug in the active_connection_count metric that affected a subset of customers was fixed. Customers exporting the metric to an external monitoring system may observe a discontinuity between historical results and current results due to this one-time correction.

2020-04-01

This release includes the following changes from the preview release:

New format request attribute

The /query request now includes a format attribute which controls the result structuring in the response body. See the /query endpoint definition for more details.

New /available endpoint

The new /available endpoint allows determining which metrics are available for a set of resources (defined by labels). This endpoint can be used to determine which subset of metrics are currently available for a specific resource (e.g. a Confluent Cloud Kafka cluster).

Metric type changes

The CUMULATIVE_(INT|DOUBLE) metric type enumeration was changed to COUNTER_(INT|DOUBLE). This was done to better align with OpenTelemetry conventions. In tandem with this change, several metrics that were improperly classified as GAUGEs were re-classified as COUNTERs.

Metric name changes

The /delta suffix has been removed from the following metrics:

  • io.confluent.kafka.server/received_bytes/delta
  • io.confluent.kafka.server/sent_bytes/delta
  • io.confluent.kafka.server/request_count/delta
2020-09-15
Retire /available endpoint

The /available endpoint (which was in Preview status) has been removed from the API. The /descriptors endpoint can still be used to determine the universe of available metrics for Metrics API.

The legacy metric names are deprecated and will stop functioning on 2020-07-01.

API Lifecycle Policy

The following status labels are applicable to APIs, features, and SDK versions, based on the current support status of each:

  • Early Access – May change at any time. Not recommended for production usage. Not officially supported by Confluent. Intended for user feedback only. Users must be granted explicit access to the API by Confluent.
  • Preview – Unlikely to change between Preview and General Availability. Not recommended for production usage. Officially supported by Confluent for non-production usage. For Closed Previews, users must be granted explicit access to the API by Confluent.
  • Generally Available (GA) – Will not change at short notice. Recommended for production usage. Officially supported by Confluent for non-production and production usage.
  • Deprecated – No longer supported. Will be removed in the future at the announced date. Use is discouraged and migration following the upgrade guide is recommended.
  • Sunset – Removed, and no longer supported or available.

Resources, operations, and individual fields in the <a href="./api.yaml" target="_blank">OpenAPI spec will be annotated with x-lifecycle-stage, x-deprecated-at, and x-sunset-at. These annotations will appear in the corresponding API Reference Documentation. An API is "Generally Available" unless explicitly marked otherwise.

Compatibility Policy

Confluent APIs are governed by <a href="https://docs.confluent.io/current/cloud/limits.html#upgrade-policy" target="_blank"> Confluent Cloud Upgrade Policy in which we will make backward incompatible changes and deprecations approximately once per year, and will provide 180 days notice via email to all registered Confluent Cloud users.

Backward Compatibility

An API version is backwards-compatible if a program written against the previous version of the API will continue to work the same way, without modification, against this version of the API.

Confluent considers the following changes to be backwards-compatible:

  • Adding new API resources.
  • Adding new optional parameters to existing API requests (e.g., query string or body).
  • Adding new properties to existing API responses.
  • Changing the order of properties in existing API responses.
  • Changing the length or format of object IDs or other opaque strings.
    • Unless otherwise documented, you can safely assume object IDs we generate will never exceed 255 characters, but you should be able to handle IDs of up to that length. If you're using MySQL, for example, you should store IDs in a VARCHAR(255) COLLATE utf8_bin column.
    • This includes adding or removing fixed prefixes (such as lkc- on kafka cluster IDs).
    • This includes API keys, API tokens, and similar authentication mechanisms.
    • This includes all strings described as "opaque" in the docs, such as pagination cursors. * Omitting properties with null values from existing API responses.
Client Responsibilities
  • Resource and rate limits, and the default and maximum sizes of paginated data are not considered part of the API contract and may change (possibly dynamically). It is the client's responsibility to read the road signs and obey the speed limit.
  • If a property has a primitive type and the API documentation does not explicitly limit its possible values, clients must not assume the values are constrained to a particular set of possible responses.
  • If a property of an object is not explicitly declared as mandatory in the API, clients must not assume it will be present.
  • A resource may be modified to return a "redirection" response (e.g. 301, 307) instead of directly returning the resource. Clients must handle HTTP-level redirects, and respect HTTP headers (e.g. Location).

Deprecation Policy

Confluent will announce deprecations at least 180 days in advance of a breaking change and we will continue to maintain the deprecated APIs in their original form during this time.

Exceptions to this policy apply in case of critical security vulnerabilities or functional defects.

Communication

When a deprecation is announced, the details and any relevant migration information will be available on the following channels:

Object Model

The object model for the Metrics API is designed similarly to the OpenTelemetry standard.

Metrics

A metric is a numeric attribute of a resource, measured at a specific point in time, labeled with contextual metadata gathered at the point of instrumentation.

There are two types of metrics:

  • GAUGE: An instantaneous measurement of a value. Gauge metrics are implicitly averaged when aggregating over time.

    Example: io.confluent.kafka.server/retained_bytes

  • COUNTER: The count of occurrences in a single (one minute) sampling interval (unless otherwise stated in the metric description). Counter metrics are implicitly summed when aggregating over time.

    Example: io.confluent.kafka.server/received_bytes

The list of metrics and their labels is available at /docs/descriptors.

Resources

A resource represents an entity against which metrics are collected. For example, a Kafka cluster, a Kafka Connector, a ksqlDB application, etc.

Each metric descriptor is associated with one or more resource descriptors, representing the resource types to which that metric can apply. A metric data point is associated with a single resource instance, identified by the resource labels on that metric data point.

For example, metrics emitted by Kafka Connect are associated to the connector resource type. Data points for those metrics include resource labels identifying the specific connector instance that emitted the metric.

The list of resource types and labels are discoverable via the /descriptors/resources endpoint.

Labels

A label is a key-value attribute associated with a metric data point.

Labels can be used in queries to filter or group the results. Labels must be prefixed when used in queries:

  • metric.<label> (for metric labels), for example metric.topic
  • resource.<resource-type>.<label> (for resource labels), for example resource.kafka.id.

The set of valid label keys for a metric include:

  • The label keys defined on that metric's descriptor itself
  • The label keys defined on the resource descriptor for the metric's associated resource type

For example, the io.confluent.kafka.server/received_bytes metric has the following labels:

  • resource.kafka.id - The Kafka cluster to which the metric pertains
  • metric.topic - The Kafka topic to which the bytes were produced
  • metric.partition - The partition to which the bytes were produced

Datasets

A dataset is a logical collection of metrics that can be queried together. The dataset is a required URL template parameter for every endpoint in this API. The following datasets are currently available:

Dataset Description
cloud

Metrics originating from Confluent Cloud resources.

Requests to this dataset require a resource filter (e.g. Kafka cluster ID, Connector ID, etc.) in the query for authorization purposes. The client's API key must be authorized for the resource referenced in the filter.

Client Considerations and Best Practices

Rate Limiting

To protect the stability of the API and keep it available to all users, Confluent employs multiple safeguards. Users who send many requests in quick succession or perform too many concurrent operations may be throttled or have their requested rejected with an error. When a rate limit is breached, an HTTP 429 Too Many Requests error is returned.

Rate limits are enforced at multiple scopes.

Global Rate Limits

A global rate limit of 60 requests per IP address, per minute is enforced.

Per-endpoint Rate Limits

Additionally, some endpoint-specific rate limits are enforced.

Endpoint Rate limit
/v2/metrics/{dataset}/export 80 requests per resource, per hour, per principal.
See the export endpoint documentation for details.

Retries

Implement retry logic in your client to gracefully handle transient API failures. This should be done by watching for error responses and building in a retry mechanism. This mechanism should follow a capped exponential backoff policy to prevent retry amplification ("retry storms") and also introduce some randomness ("jitter") to avoid the thundering herd effect.

Metric Data Latency

Metric data points are typically available for query in the API within 5 minutes of their origination at the source. This latency can vary based on network conditions and processing overhead. Clients that are polling (or "scraping") metrics into an external monitoring system should account for this latency in their polling requests. API requests that fail to incorporate the latency into the query interval may have incomplete data in the response.

Pagination

Cursors, tokens, and corresponding pagination links may expire after a short amount of time. In this case, the API will return a 400 Bad Request error and the client will need to restart from the beginning.

The client should have no trouble pausing between rate limiting windows, but persisting cursors for hours or days is not recommended.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version:
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://confluent.io

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import v2 "github.com/confluentinc/ccloud-sdk-go-v2"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), v2.ContextServerIndex, 1)
Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), v2.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), v2.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), v2.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.telemetry.confluent.cloud

Class Method HTTP request Description
Version1Api V1MetricsDatasetAttributesPost Post /v1/metrics/{dataset}/attributes Query label values
Version1Api V1MetricsDatasetDescriptorsGet Get /v1/metrics/{dataset}/descriptors List all metric descriptors
Version1Api V1MetricsDatasetQueryPost Post /v1/metrics/{dataset}/query Query metric values
Version2Api V2MetricsDatasetAttributesPost Post /v2/metrics/{dataset}/attributes Query label values
Version2Api V2MetricsDatasetDescriptorsMetricsGet Get /v2/metrics/{dataset}/descriptors/metrics List metric descriptors
Version2Api V2MetricsDatasetDescriptorsResourcesGet Get /v2/metrics/{dataset}/descriptors/resources List resource descriptors
Version2Api V2MetricsDatasetExportGet Get /v2/metrics/{dataset}/export Export metric values
Version2Api V2MetricsDatasetQueryPost Post /v2/metrics/{dataset}/query Query metric values

Documentation For Models

Documentation For Authorization

api-key
  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

support@confluent.io

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
	ContextHttpSignatureAuth = contextKey("httpsignature")

	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)
View Source 
var AllowedAggregationFunctionEnumValues = []AggregationFunction{
	"SUM",
}

All allowed values of AggregationFunction enum

View Source 
var AllowedGranularityEnumValues = []Granularity{
	"PT1M",
	"PT5M",
	"PT15M",
	"PT30M",
	"PT1H",
	"PT4H",
	"PT6H",
	"PT12H",
	"P1D",
	"ALL",
}

All allowed values of Granularity enum

View Source 
var AllowedResponseFormatEnumValues = []ResponseFormat{
	"FLAT",
	"GROUPED",
}

All allowed values of ResponseFormat enum

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func PtrBool 

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32 

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64 

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt 

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32 

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64 

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString 

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime 

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient 

type APIClient struct {
	Version1Api Version1Api

	Version2Api Version2Api
	// contains filtered or unexported fields
}

APIClient manages communication with the Confluent Cloud Metrics API API v In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type Aggregation 

type Aggregation struct {
	// The metric to aggregate.
	Metric string `json:"metric"`
	// The aggregation function for the label buckets defined in `group_by`.
	Agg NullableAggregationFunction `json:"agg,omitempty"`
}

Aggregation struct for Aggregation

func NewAggregation 

func NewAggregation(metric string) *Aggregation

NewAggregation instantiates a new Aggregation object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAggregationWithDefaults 

func NewAggregationWithDefaults() *Aggregation

NewAggregationWithDefaults instantiates a new Aggregation object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Aggregation) GetAgg 

func (o *Aggregation) GetAgg() AggregationFunction

GetAgg returns the Agg field value if set, zero value otherwise (both if not set or set to explicit null).

func (*Aggregation) GetAggOk 

func (o *Aggregation) GetAggOk() (*AggregationFunction, bool)

GetAggOk returns a tuple with the Agg field value if set, nil otherwise and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Aggregation) GetMetric 

func (o *Aggregation) GetMetric() string

GetMetric returns the Metric field value

func (*Aggregation) GetMetricOk 

func (o *Aggregation) GetMetricOk() (*string, bool)

GetMetricOk returns a tuple with the Metric field value and a boolean to check if the value has been set.

func (*Aggregation) HasAgg 

func (o *Aggregation) HasAgg() bool

HasAgg returns a boolean if a field has been set.

func (Aggregation) MarshalJSON 

func (o Aggregation) MarshalJSON() ([]byte, error)

func (*Aggregation) Redact 

func (o *Aggregation) Redact()

Redact resets all sensitive fields to their zero value.

func (*Aggregation) SetAgg 

func (o *Aggregation) SetAgg(v AggregationFunction)

SetAgg gets a reference to the given NullableAggregationFunction and assigns it to the Agg field.

func (*Aggregation) SetAggNil 

func (o *Aggregation) SetAggNil()

SetAggNil sets the value for Agg to be an explicit nil

func (*Aggregation) SetMetric 

func (o *Aggregation) SetMetric(v string)

SetMetric sets field value

func (*Aggregation) UnsetAgg 

func (o *Aggregation) UnsetAgg()

UnsetAgg ensures that no value is present for Agg, not even an explicit nil

type AggregationFunction 

type AggregationFunction string

AggregationFunction the model 'AggregationFunction' 

const (
	SUM AggregationFunction = "SUM"
)

List of AggregationFunction

func NewAggregationFunctionFromValue 

func NewAggregationFunctionFromValue(v string) (*AggregationFunction, error)

NewAggregationFunctionFromValue returns a pointer to a valid AggregationFunction for the value passed as argument, or an error if the value passed is not allowed by the enum

func (AggregationFunction) IsValid 

func (v AggregationFunction) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (AggregationFunction) Ptr 

func (v AggregationFunction) Ptr() *AggregationFunction

Ptr returns reference to AggregationFunction value

func (*AggregationFunction) UnmarshalJSON 

func (v *AggregationFunction) UnmarshalJSON(src []byte) error

type ApiV1MetricsDatasetAttributesPostRequest 

type ApiV1MetricsDatasetAttributesPostRequest struct {
	ApiService Version1Api
	// contains filtered or unexported fields
}

func (ApiV1MetricsDatasetAttributesPostRequest) Execute 

func (r ApiV1MetricsDatasetAttributesPostRequest) Execute() (*AttributesResponse, *http.Response, error)

func (ApiV1MetricsDatasetAttributesPostRequest) PageToken 

func (r ApiV1MetricsDatasetAttributesPostRequest) PageToken(pageToken string) ApiV1MetricsDatasetAttributesPostRequest

The next page token. The token is returned by the previous request as part of &#x60;meta.pagination&#x60;.

func (ApiV1MetricsDatasetAttributesPostRequest) V1MetricsDatasetAttributesPostRequest 

func (r ApiV1MetricsDatasetAttributesPostRequest) V1MetricsDatasetAttributesPostRequest(v1MetricsDatasetAttributesPostRequest V1MetricsDatasetAttributesPostRequest) ApiV1MetricsDatasetAttributesPostRequest

type ApiV1MetricsDatasetDescriptorsGetRequest 

type ApiV1MetricsDatasetDescriptorsGetRequest struct {
	ApiService Version1Api
	// contains filtered or unexported fields
}

func (ApiV1MetricsDatasetDescriptorsGetRequest) Execute 

func (r ApiV1MetricsDatasetDescriptorsGetRequest) Execute() (*ListMetricDescriptorsResponse, *http.Response, error)

func (ApiV1MetricsDatasetDescriptorsGetRequest) PageSize 

func (r ApiV1MetricsDatasetDescriptorsGetRequest) PageSize(pageSize int32) ApiV1MetricsDatasetDescriptorsGetRequest

The maximum number of results to return. The page size is an integer in the range from 1 through 1000.

func (ApiV1MetricsDatasetDescriptorsGetRequest) PageToken 

func (r ApiV1MetricsDatasetDescriptorsGetRequest) PageToken(pageToken string) ApiV1MetricsDatasetDescriptorsGetRequest

The next page token. The token is returned by the previous request as part of &#x60;meta.pagination&#x60;.

type ApiV1MetricsDatasetQueryPostRequest 

type ApiV1MetricsDatasetQueryPostRequest struct {
	ApiService Version1Api
	// contains filtered or unexported fields
}

func (ApiV1MetricsDatasetQueryPostRequest) Execute 

func (r ApiV1MetricsDatasetQueryPostRequest) Execute() (*QueryResponse, *http.Response, error)

func (ApiV1MetricsDatasetQueryPostRequest) QueryRequest 

func (r ApiV1MetricsDatasetQueryPostRequest) QueryRequest(queryRequest QueryRequest) ApiV1MetricsDatasetQueryPostRequest

type ApiV2MetricsDatasetAttributesPostRequest 

type ApiV2MetricsDatasetAttributesPostRequest struct {
	ApiService Version2Api
	// contains filtered or unexported fields
}

func (ApiV2MetricsDatasetAttributesPostRequest) AttributesRequest 

func (r ApiV2MetricsDatasetAttributesPostRequest) AttributesRequest(attributesRequest AttributesRequest) ApiV2MetricsDatasetAttributesPostRequest

func (ApiV2MetricsDatasetAttributesPostRequest) Execute 

func (r ApiV2MetricsDatasetAttributesPostRequest) Execute() (*AttributesResponse, *http.Response, error)

func (ApiV2MetricsDatasetAttributesPostRequest) PageToken 

func (r ApiV2MetricsDatasetAttributesPostRequest) PageToken(pageToken string) ApiV2MetricsDatasetAttributesPostRequest

The next page token. The token is returned by the previous request as part of &#x60;meta.pagination&#x60;.

type ApiV2MetricsDatasetDescriptorsMetricsGetRequest 

type ApiV2MetricsDatasetDescriptorsMetricsGetRequest struct {
	ApiService Version2Api
	// contains filtered or unexported fields
}

func (ApiV2MetricsDatasetDescriptorsMetricsGetRequest) Execute 

func (r ApiV2MetricsDatasetDescriptorsMetricsGetRequest) Execute() (*ListMetricDescriptorsResponse, *http.Response, error)

func (ApiV2MetricsDatasetDescriptorsMetricsGetRequest) PageSize 

func (r ApiV2MetricsDatasetDescriptorsMetricsGetRequest) PageSize(pageSize int32) ApiV2MetricsDatasetDescriptorsMetricsGetRequest

The maximum number of results to return. The page size is an integer in the range from 1 through 1000.

func (ApiV2MetricsDatasetDescriptorsMetricsGetRequest) PageToken 

func (r ApiV2MetricsDatasetDescriptorsMetricsGetRequest) PageToken(pageToken string) ApiV2MetricsDatasetDescriptorsMetricsGetRequest

The next page token. The token is returned by the previous request as part of &#x60;meta.pagination&#x60;.

func (ApiV2MetricsDatasetDescriptorsMetricsGetRequest) ResourceType 

func (r ApiV2MetricsDatasetDescriptorsMetricsGetRequest) ResourceType(resourceType string) ApiV2MetricsDatasetDescriptorsMetricsGetRequest

The type of the resource to list metric descriptors for.

type ApiV2MetricsDatasetDescriptorsResourcesGetRequest 

type ApiV2MetricsDatasetDescriptorsResourcesGetRequest struct {
	ApiService Version2Api
	// contains filtered or unexported fields
}

func (ApiV2MetricsDatasetDescriptorsResourcesGetRequest) Execute 

func (r ApiV2MetricsDatasetDescriptorsResourcesGetRequest) Execute() (*ListResourceDescriptorsResponse, *http.Response, error)

func (ApiV2MetricsDatasetDescriptorsResourcesGetRequest) PageSize 

func (r ApiV2MetricsDatasetDescriptorsResourcesGetRequest) PageSize(pageSize int32) ApiV2MetricsDatasetDescriptorsResourcesGetRequest

The maximum number of results to return. The page size is an integer in the range from 1 through 1000.

func (ApiV2MetricsDatasetDescriptorsResourcesGetRequest) PageToken 

func (r ApiV2MetricsDatasetDescriptorsResourcesGetRequest) PageToken(pageToken string) ApiV2MetricsDatasetDescriptorsResourcesGetRequest

The next page token. The token is returned by the previous request as part of &#x60;meta.pagination&#x60;.

type ApiV2MetricsDatasetExportGetRequest 

type ApiV2MetricsDatasetExportGetRequest struct {
	ApiService Version2Api
	// contains filtered or unexported fields
}

func (ApiV2MetricsDatasetExportGetRequest) Execute 

func (r ApiV2MetricsDatasetExportGetRequest) Execute() (string, *http.Response, error)

func (ApiV2MetricsDatasetExportGetRequest) Metric 

func (r ApiV2MetricsDatasetExportGetRequest) Metric(metric []string) ApiV2MetricsDatasetExportGetRequest

The metric to export. If this parameter is not specified, all metrics for the resource will be exported. This parameter can be specified multiple times.

func (ApiV2MetricsDatasetExportGetRequest) ResourceConnectorId 

func (r ApiV2MetricsDatasetExportGetRequest) ResourceConnectorId(resourceConnectorId []string) ApiV2MetricsDatasetExportGetRequest

The ID of the Connector to export metrics for. This parameter can be specified multiple times.

func (ApiV2MetricsDatasetExportGetRequest) ResourceKafkaId 

func (r ApiV2MetricsDatasetExportGetRequest) ResourceKafkaId(resourceKafkaId []string) ApiV2MetricsDatasetExportGetRequest

The ID of the Kafka cluster to export metrics for. This parameter can be specified multiple times (e.g. &#x60;?resource.kafka.id&#x3D;lkc-1&amp;resource.kafka.id&#x3D;lkc-2&#x60;).

func (ApiV2MetricsDatasetExportGetRequest) ResourceKsqlId 

func (r ApiV2MetricsDatasetExportGetRequest) ResourceKsqlId(resourceKsqlId []string) ApiV2MetricsDatasetExportGetRequest

The ID of the ksqlDB application to export metrics for. This parameter can be specified multiple times.

func (ApiV2MetricsDatasetExportGetRequest) ResourceSchemaRegistryId 

func (r ApiV2MetricsDatasetExportGetRequest) ResourceSchemaRegistryId(resourceSchemaRegistryId []string) ApiV2MetricsDatasetExportGetRequest

The ID of the Schema Registry to export metrics for. This parameter can be specified multiple times.

type ApiV2MetricsDatasetQueryPostRequest 

type ApiV2MetricsDatasetQueryPostRequest struct {
	ApiService Version2Api
	// contains filtered or unexported fields
}

func (ApiV2MetricsDatasetQueryPostRequest) Execute 

func (r ApiV2MetricsDatasetQueryPostRequest) Execute() (*QueryResponse, *http.Response, error)

func (ApiV2MetricsDatasetQueryPostRequest) PageToken 

func (r ApiV2MetricsDatasetQueryPostRequest) PageToken(pageToken string) ApiV2MetricsDatasetQueryPostRequest

The next page token. The token is returned by the previous request as part of &#x60;meta.pagination&#x60;. Pagination is only supported for requests containing a &#x60;group_by&#x60; element.

func (ApiV2MetricsDatasetQueryPostRequest) QueryRequest 

func (r ApiV2MetricsDatasetQueryPostRequest) QueryRequest(queryRequest QueryRequest) ApiV2MetricsDatasetQueryPostRequest

type AttributesRequest 

type AttributesRequest struct {
	// The metric that the label values are enumerated for.
	Metric *string `json:"metric,omitempty"`
	// The label(s) that the values are enumerated for.
	GroupBy []string `json:"group_by"`
	Filter  *Filter  `json:"filter,omitempty"`
	// Defines the time range(s) for which available metrics will be listed. A time range is an ISO-8601 interval. When unspecified, the value defaults to the last hour before the request was made
	Intervals []string `json:"intervals,omitempty"`
	Limit     *int32   `json:"limit,omitempty"`
}

AttributesRequest struct for AttributesRequest

func NewAttributesRequest 

func NewAttributesRequest(groupBy []string) *AttributesRequest

NewAttributesRequest instantiates a new AttributesRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAttributesRequestWithDefaults 

func NewAttributesRequestWithDefaults() *AttributesRequest

NewAttributesRequestWithDefaults instantiates a new AttributesRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AttributesRequest) GetFilter 

func (o *AttributesRequest) GetFilter() Filter

GetFilter returns the Filter field value if set, zero value otherwise.

func (*AttributesRequest) GetFilterOk 

func (o *AttributesRequest) GetFilterOk() (*Filter, bool)

GetFilterOk returns a tuple with the Filter field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AttributesRequest) GetGroupBy 

func (o *AttributesRequest) GetGroupBy() []string

GetGroupBy returns the GroupBy field value

func (*AttributesRequest) GetGroupByOk 

func (o *AttributesRequest) GetGroupByOk() ([]string, bool)

GetGroupByOk returns a tuple with the GroupBy field value and a boolean to check if the value has been set.

func (*AttributesRequest) GetIntervals 

func (o *AttributesRequest) GetIntervals() []string

GetIntervals returns the Intervals field value if set, zero value otherwise.

func (*AttributesRequest) GetIntervalsOk 

func (o *AttributesRequest) GetIntervalsOk() ([]string, bool)

GetIntervalsOk returns a tuple with the Intervals field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AttributesRequest) GetLimit 

func (o *AttributesRequest) GetLimit() int32

GetLimit returns the Limit field value if set, zero value otherwise.

func (*AttributesRequest) GetLimitOk 

func (o *AttributesRequest) GetLimitOk() (*int32, bool)

GetLimitOk returns a tuple with the Limit field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AttributesRequest) GetMetric 

func (o *AttributesRequest) GetMetric() string

GetMetric returns the Metric field value if set, zero value otherwise.

func (*AttributesRequest) GetMetricOk 

func (o *AttributesRequest) GetMetricOk() (*string, bool)

GetMetricOk returns a tuple with the Metric field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AttributesRequest) HasFilter 

func (o *AttributesRequest) HasFilter() bool

HasFilter returns a boolean if a field has been set.

func (*AttributesRequest) HasIntervals 

func (o *AttributesRequest) HasIntervals() bool

HasIntervals returns a boolean if a field has been set.

func (*AttributesRequest) HasLimit 

func (o *AttributesRequest) HasLimit() bool

HasLimit returns a boolean if a field has been set.

func (*AttributesRequest) HasMetric 

func (o *AttributesRequest) HasMetric() bool

HasMetric returns a boolean if a field has been set.

func (AttributesRequest) MarshalJSON 

func (o AttributesRequest) MarshalJSON() ([]byte, error)

func (*AttributesRequest) Redact 

func (o *AttributesRequest) Redact()

Redact resets all sensitive fields to their zero value.

func (*AttributesRequest) SetFilter 

func (o *AttributesRequest) SetFilter(v Filter)

SetFilter gets a reference to the given Filter and assigns it to the Filter field.

func (*AttributesRequest) SetGroupBy 

func (o *AttributesRequest) SetGroupBy(v []string)

SetGroupBy sets field value

func (*AttributesRequest) SetIntervals 

func (o *AttributesRequest) SetIntervals(v []string)

SetIntervals gets a reference to the given []string and assigns it to the Intervals field.

func (*AttributesRequest) SetLimit 

func (o *AttributesRequest) SetLimit(v int32)

SetLimit gets a reference to the given int32 and assigns it to the Limit field.

func (*AttributesRequest) SetMetric 

func (o *AttributesRequest) SetMetric(v string)

SetMetric gets a reference to the given string and assigns it to the Metric field.

type AttributesResponse 

type AttributesResponse struct {
	// The enumerated labels, as an array of key/value pairs.
	Data  []map[string]string `json:"data"`
	Meta  Meta                `json:"meta"`
	Links *Links              `json:"links,omitempty"`
}

AttributesResponse struct for AttributesResponse

func NewAttributesResponse 

func NewAttributesResponse(data []map[string]string, meta Meta) *AttributesResponse

NewAttributesResponse instantiates a new AttributesResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAttributesResponseWithDefaults 

func NewAttributesResponseWithDefaults() *AttributesResponse

NewAttributesResponseWithDefaults instantiates a new AttributesResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AttributesResponse) GetData 

func (o *AttributesResponse) GetData() []map[string]string

GetData returns the Data field value

func (*AttributesResponse) GetDataOk 

func (o *AttributesResponse) GetDataOk() ([]map[string]string, bool)

GetDataOk returns a tuple with the Data field value and a boolean to check if the value has been set. 

func (o *AttributesResponse) GetLinks() Links

GetLinks returns the Links field value if set, zero value otherwise.

func (*AttributesResponse) GetLinksOk 

func (o *AttributesResponse) GetLinksOk() (*Links, bool)

GetLinksOk returns a tuple with the Links field value if set, nil otherwise and a boolean to check if the value has been set.

func (*AttributesResponse) GetMeta 

func (o *AttributesResponse) GetMeta() Meta

GetMeta returns the Meta field value

func (*AttributesResponse) GetMetaOk 

func (o *AttributesResponse) GetMetaOk() (*Meta, bool)

GetMetaOk returns a tuple with the Meta field value and a boolean to check if the value has been set. 

func (o *AttributesResponse) HasLinks() bool

HasLinks returns a boolean if a field has been set.

func (AttributesResponse) MarshalJSON 

func (o AttributesResponse) MarshalJSON() ([]byte, error)

func (*AttributesResponse) Redact 

func (o *AttributesResponse) Redact()

Redact resets all sensitive fields to their zero value.

func (*AttributesResponse) SetData 

func (o *AttributesResponse) SetData(v []map[string]string)

SetData sets field value 

func (o *AttributesResponse) SetLinks(v Links)

SetLinks gets a reference to the given Links and assigns it to the Links field.

func (*AttributesResponse) SetMeta 

func (o *AttributesResponse) SetMeta(v Meta)

SetMeta sets field value

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type CompoundFilter 

type CompoundFilter struct {
	Op      string   `json:"op"`
	Filters []Filter `json:"filters"`
}

CompoundFilter struct for CompoundFilter

func NewCompoundFilter 

func NewCompoundFilter(op string, filters []Filter) *CompoundFilter

NewCompoundFilter instantiates a new CompoundFilter object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCompoundFilterWithDefaults 

func NewCompoundFilterWithDefaults() *CompoundFilter

NewCompoundFilterWithDefaults instantiates a new CompoundFilter object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CompoundFilter) GetFilters 

func (o *CompoundFilter) GetFilters() []Filter

GetFilters returns the Filters field value

func (*CompoundFilter) GetFiltersOk 

func (o *CompoundFilter) GetFiltersOk() ([]Filter, bool)

GetFiltersOk returns a tuple with the Filters field value and a boolean to check if the value has been set.

func (*CompoundFilter) GetOp 

func (o *CompoundFilter) GetOp() string

GetOp returns the Op field value

func (*CompoundFilter) GetOpOk 

func (o *CompoundFilter) GetOpOk() (*string, bool)

GetOpOk returns a tuple with the Op field value and a boolean to check if the value has been set.

func (CompoundFilter) MarshalJSON 

func (o CompoundFilter) MarshalJSON() ([]byte, error)

func (*CompoundFilter) Redact 

func (o *CompoundFilter) Redact()

Redact resets all sensitive fields to their zero value.

func (*CompoundFilter) SetFilters 

func (o *CompoundFilter) SetFilters(v []Filter)

SetFilters sets field value

func (*CompoundFilter) SetOp 

func (o *CompoundFilter) SetOp(v string)

SetOp sets field value

type Configuration 

type Configuration struct {
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	Debug            bool              `json:"debug,omitempty"`
	Servers          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	HTTPClient       *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL 

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext 

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

type ErrorResponse 

type ErrorResponse struct {
	Errors []ErrorResponseErrorsInner `json:"errors"`
}

ErrorResponse struct for ErrorResponse

func NewErrorResponse 

func NewErrorResponse(errors []ErrorResponseErrorsInner) *ErrorResponse

NewErrorResponse instantiates a new ErrorResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewErrorResponseWithDefaults 

func NewErrorResponseWithDefaults() *ErrorResponse

NewErrorResponseWithDefaults instantiates a new ErrorResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ErrorResponse) GetErrors 

func (o *ErrorResponse) GetErrors() []ErrorResponseErrorsInner

GetErrors returns the Errors field value

func (*ErrorResponse) GetErrorsOk 

func (o *ErrorResponse) GetErrorsOk() ([]ErrorResponseErrorsInner, bool)

GetErrorsOk returns a tuple with the Errors field value and a boolean to check if the value has been set.

func (ErrorResponse) MarshalJSON 

func (o ErrorResponse) MarshalJSON() ([]byte, error)

func (*ErrorResponse) Redact 

func (o *ErrorResponse) Redact()

Redact resets all sensitive fields to their zero value.

func (*ErrorResponse) SetErrors 

func (o *ErrorResponse) SetErrors(v []ErrorResponseErrorsInner)

SetErrors sets field value

type ErrorResponseErrorsInner 

type ErrorResponseErrorsInner struct {
	// A unique identifier for this particular occurrence of the problem.
	Id *string `json:"id,omitempty"`
	// The HTTP status code applicable to this problem, expressed as a string value.
	Status *string `json:"status,omitempty"`
	// An application-specific error code, expressed as a string value.
	Code *string `json:"code,omitempty"`
	// A human-readable explanation specific to this occurrence of the problem.
	Detail *string `json:"detail,omitempty"`
	Meta   *Meta   `json:"meta,omitempty"`
	Links  *Links  `json:"links,omitempty"`
}

ErrorResponseErrorsInner struct for ErrorResponseErrorsInner

func NewErrorResponseErrorsInner 

func NewErrorResponseErrorsInner() *ErrorResponseErrorsInner

NewErrorResponseErrorsInner instantiates a new ErrorResponseErrorsInner object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewErrorResponseErrorsInnerWithDefaults 

func NewErrorResponseErrorsInnerWithDefaults() *ErrorResponseErrorsInner

NewErrorResponseErrorsInnerWithDefaults instantiates a new ErrorResponseErrorsInner object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ErrorResponseErrorsInner) GetCode 

func (o *ErrorResponseErrorsInner) GetCode() string

GetCode returns the Code field value if set, zero value otherwise.

func (*ErrorResponseErrorsInner) GetCodeOk 

func (o *ErrorResponseErrorsInner) GetCodeOk() (*string, bool)

GetCodeOk returns a tuple with the Code field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorResponseErrorsInner) GetDetail 

func (o *ErrorResponseErrorsInner) GetDetail() string

GetDetail returns the Detail field value if set, zero value otherwise.

func (*ErrorResponseErrorsInner) GetDetailOk 

func (o *ErrorResponseErrorsInner) GetDetailOk() (*string, bool)

GetDetailOk returns a tuple with the Detail field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorResponseErrorsInner) GetId 

func (o *ErrorResponseErrorsInner) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*ErrorResponseErrorsInner) GetIdOk 

func (o *ErrorResponseErrorsInner) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set. 

func (o *ErrorResponseErrorsInner) GetLinks() Links

GetLinks returns the Links field value if set, zero value otherwise.

func (*ErrorResponseErrorsInner) GetLinksOk 

func (o *ErrorResponseErrorsInner) GetLinksOk() (*Links, bool)

GetLinksOk returns a tuple with the Links field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorResponseErrorsInner) GetMeta 

func (o *ErrorResponseErrorsInner) GetMeta() Meta

GetMeta returns the Meta field value if set, zero value otherwise.

func (*ErrorResponseErrorsInner) GetMetaOk 

func (o *ErrorResponseErrorsInner) GetMetaOk() (*Meta, bool)

GetMetaOk returns a tuple with the Meta field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorResponseErrorsInner) GetStatus 

func (o *ErrorResponseErrorsInner) GetStatus() string

GetStatus returns the Status field value if set, zero value otherwise.

func (*ErrorResponseErrorsInner) GetStatusOk 

func (o *ErrorResponseErrorsInner) GetStatusOk() (*string, bool)

GetStatusOk returns a tuple with the Status field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorResponseErrorsInner) HasCode 

func (o *ErrorResponseErrorsInner) HasCode() bool

HasCode returns a boolean if a field has been set.

func (*ErrorResponseErrorsInner) HasDetail 

func (o *ErrorResponseErrorsInner) HasDetail() bool

HasDetail returns a boolean if a field has been set.

func (*ErrorResponseErrorsInner) HasId 

func (o *ErrorResponseErrorsInner) HasId() bool

HasId returns a boolean if a field has been set. 

func (o *ErrorResponseErrorsInner) HasLinks() bool

HasLinks returns a boolean if a field has been set.

func (*ErrorResponseErrorsInner) HasMeta 

func (o *ErrorResponseErrorsInner) HasMeta() bool

HasMeta returns a boolean if a field has been set.

func (*ErrorResponseErrorsInner) HasStatus 

func (o *ErrorResponseErrorsInner) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (ErrorResponseErrorsInner) MarshalJSON 

func (o ErrorResponseErrorsInner) MarshalJSON() ([]byte, error)

func (*ErrorResponseErrorsInner) Redact 

func (o *ErrorResponseErrorsInner) Redact()

Redact resets all sensitive fields to their zero value.

func (*ErrorResponseErrorsInner) SetCode 

func (o *ErrorResponseErrorsInner) SetCode(v string)

SetCode gets a reference to the given string and assigns it to the Code field.

func (*ErrorResponseErrorsInner) SetDetail 

func (o *ErrorResponseErrorsInner) SetDetail(v string)

SetDetail gets a reference to the given string and assigns it to the Detail field.

func (*ErrorResponseErrorsInner) SetId 

func (o *ErrorResponseErrorsInner) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field. 

func (o *ErrorResponseErrorsInner) SetLinks(v Links)

SetLinks gets a reference to the given Links and assigns it to the Links field.

func (*ErrorResponseErrorsInner) SetMeta 

func (o *ErrorResponseErrorsInner) SetMeta(v Meta)

SetMeta gets a reference to the given Meta and assigns it to the Meta field.

func (*ErrorResponseErrorsInner) SetStatus 

func (o *ErrorResponseErrorsInner) SetStatus(v string)

SetStatus gets a reference to the given string and assigns it to the Status field.

type FieldFilter 

type FieldFilter struct {
	// The comparison operator for the filter. Note that labels are compared _lexicographically_.  The `GT` or `GTE` operators can be used to page through grouped result sets that exceed the query limit.
	Op string `json:"op"`
	// The field to filter on; see [here](#section/Object-Model/Labels) on using labels as filter fields.
	Field *string          `json:"field,omitempty"`
	Value FieldFilterValue `json:"value"`
}

FieldFilter struct for FieldFilter

func NewFieldFilter 

func NewFieldFilter(op string, value FieldFilterValue) *FieldFilter

NewFieldFilter instantiates a new FieldFilter object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewFieldFilterWithDefaults 

func NewFieldFilterWithDefaults() *FieldFilter

NewFieldFilterWithDefaults instantiates a new FieldFilter object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*FieldFilter) GetField 

func (o *FieldFilter) GetField() string

GetField returns the Field field value if set, zero value otherwise.

func (*FieldFilter) GetFieldOk 

func (o *FieldFilter) GetFieldOk() (*string, bool)

GetFieldOk returns a tuple with the Field field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FieldFilter) GetOp 

func (o *FieldFilter) GetOp() string

GetOp returns the Op field value

func (*FieldFilter) GetOpOk 

func (o *FieldFilter) GetOpOk() (*string, bool)

GetOpOk returns a tuple with the Op field value and a boolean to check if the value has been set.

func (*FieldFilter) GetValue 

func (o *FieldFilter) GetValue() FieldFilterValue

GetValue returns the Value field value

func (*FieldFilter) GetValueOk 

func (o *FieldFilter) GetValueOk() (*FieldFilterValue, bool)

GetValueOk returns a tuple with the Value field value and a boolean to check if the value has been set.

func (*FieldFilter) HasField 

func (o *FieldFilter) HasField() bool

HasField returns a boolean if a field has been set.

func (FieldFilter) MarshalJSON 

func (o FieldFilter) MarshalJSON() ([]byte, error)

func (*FieldFilter) Redact 

func (o *FieldFilter) Redact()

Redact resets all sensitive fields to their zero value.

func (*FieldFilter) SetField 

func (o *FieldFilter) SetField(v string)

SetField gets a reference to the given string and assigns it to the Field field.

func (*FieldFilter) SetOp 

func (o *FieldFilter) SetOp(v string)

SetOp sets field value

func (*FieldFilter) SetValue 

func (o *FieldFilter) SetValue(v FieldFilterValue)

SetValue sets field value

type FieldFilterValue 

type FieldFilterValue struct {
	Int32  *int32
	String *string
}

FieldFilterValue - struct for FieldFilterValue

func Int32AsFieldFilterValue 

func Int32AsFieldFilterValue(v *int32) FieldFilterValue

int32AsFieldFilterValue is a convenience function that returns int32 wrapped in FieldFilterValue

func StringAsFieldFilterValue 

func StringAsFieldFilterValue(v *string) FieldFilterValue

stringAsFieldFilterValue is a convenience function that returns string wrapped in FieldFilterValue

func (*FieldFilterValue) GetActualInstance 

func (obj *FieldFilterValue) GetActualInstance() interface{}

Get the actual instance

func (FieldFilterValue) MarshalJSON 

func (src FieldFilterValue) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON

func (*FieldFilterValue) UnmarshalJSON 

func (dst *FieldFilterValue) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one of the pointers in the struct

type Filter 

type Filter struct {
	CompoundFilter *CompoundFilter
	FieldFilter    *FieldFilter
	UnaryFilter    *UnaryFilter
}

Filter - Metric filter.

func CompoundFilterAsFilter 

func CompoundFilterAsFilter(v *CompoundFilter) Filter

CompoundFilterAsFilter is a convenience function that returns CompoundFilter wrapped in Filter

func FieldFilterAsFilter 

func FieldFilterAsFilter(v *FieldFilter) Filter

FieldFilterAsFilter is a convenience function that returns FieldFilter wrapped in Filter

func UnaryFilterAsFilter 

func UnaryFilterAsFilter(v *UnaryFilter) Filter

UnaryFilterAsFilter is a convenience function that returns UnaryFilter wrapped in Filter

func (*Filter) GetActualInstance 

func (obj *Filter) GetActualInstance() interface{}

Get the actual instance

func (Filter) MarshalJSON 

func (src Filter) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON

func (*Filter) UnmarshalJSON 

func (dst *Filter) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one of the pointers in the struct

type FlatQueryResponse 

type FlatQueryResponse struct {
	// An array of results for this query. Each item includes `timestamp`, `value`, and an attribute for each label specified in the request's `group_by`.
	Data []Point `json:"data"`
}

FlatQueryResponse struct for FlatQueryResponse

func NewFlatQueryResponse 

func NewFlatQueryResponse(data []Point) *FlatQueryResponse

NewFlatQueryResponse instantiates a new FlatQueryResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewFlatQueryResponseWithDefaults 

func NewFlatQueryResponseWithDefaults() *FlatQueryResponse

NewFlatQueryResponseWithDefaults instantiates a new FlatQueryResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*FlatQueryResponse) GetData 

func (o *FlatQueryResponse) GetData() []Point

GetData returns the Data field value

func (*FlatQueryResponse) GetDataOk 

func (o *FlatQueryResponse) GetDataOk() ([]Point, bool)

GetDataOk returns a tuple with the Data field value and a boolean to check if the value has been set.

func (FlatQueryResponse) MarshalJSON 

func (o FlatQueryResponse) MarshalJSON() ([]byte, error)

func (*FlatQueryResponse) Redact 

func (o *FlatQueryResponse) Redact()

Redact resets all sensitive fields to their zero value.

func (*FlatQueryResponse) SetData 

func (o *FlatQueryResponse) SetData(v []Point)

SetData sets field value

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type Granularity 

type Granularity string

Granularity Defines the time buckets that the aggregation is performed for. Buckets are specified in [ISO-8601 duration syntax](https://en.wikipedia.org/wiki/ISO_8601#Durations), but only the enumerated values are supported. Buckets are aligned to UTC boundaries. The special `ALL` value defines a single bucket for all intervals. The allowed granularity for a query is restricted by the length of that query's `interval`. | Granularity | Maximum Interval Length | |----------------------|--------------------------| | `PT1M` (1 minute) | 6 hours | | `PT5M` (5 minutes) | 1 day | | `PT15M` (15 minutes) | 4 days | | `PT30M` (30 minutes) | 7 days | | `PT1H` (1 hour) | Unlimited | | `PT4H` (4 hours) | Unlimited | | `PT6H` (6 hours) | Unlimited | | `PT12H` (12 hours) | Unlimited | | `P1D` (1 day) | Unlimited | | `ALL` | Unlimited | 

const (
	PT1_M  Granularity = "PT1M"
	PT5_M  Granularity = "PT5M"
	PT15_M Granularity = "PT15M"
	PT30_M Granularity = "PT30M"
	PT1_H  Granularity = "PT1H"
	PT4_H  Granularity = "PT4H"
	PT6_H  Granularity = "PT6H"
	PT12_H Granularity = "PT12H"
	P1_D   Granularity = "P1D"
	ALL    Granularity = "ALL"
)

List of Granularity

func NewGranularityFromValue 

func NewGranularityFromValue(v string) (*Granularity, error)

NewGranularityFromValue returns a pointer to a valid Granularity for the value passed as argument, or an error if the value passed is not allowed by the enum

func (Granularity) IsValid 

func (v Granularity) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (Granularity) Ptr 

func (v Granularity) Ptr() *Granularity

Ptr returns reference to Granularity value

func (*Granularity) UnmarshalJSON 

func (v *Granularity) UnmarshalJSON(src []byte) error

type GroupedQueryResponse 

type GroupedQueryResponse struct {
	// An array of results for this query. Each item represents a group bucket having a distinct set of label values for the request's `group_by`.  The groups are ordered lexicographically by the label values for that group.
	Data []GroupedQueryResponseDataInner `json:"data"`
}

GroupedQueryResponse struct for GroupedQueryResponse

func NewGroupedQueryResponse 

func NewGroupedQueryResponse(data []GroupedQueryResponseDataInner) *GroupedQueryResponse

NewGroupedQueryResponse instantiates a new GroupedQueryResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewGroupedQueryResponseWithDefaults 

func NewGroupedQueryResponseWithDefaults() *GroupedQueryResponse

NewGroupedQueryResponseWithDefaults instantiates a new GroupedQueryResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*GroupedQueryResponse) GetData 

func (o *GroupedQueryResponse) GetData() []GroupedQueryResponseDataInner

GetData returns the Data field value

func (*GroupedQueryResponse) GetDataOk 

func (o *GroupedQueryResponse) GetDataOk() ([]GroupedQueryResponseDataInner, bool)

GetDataOk returns a tuple with the Data field value and a boolean to check if the value has been set.

func (GroupedQueryResponse) MarshalJSON 

func (o GroupedQueryResponse) MarshalJSON() ([]byte, error)

func (*GroupedQueryResponse) Redact 

func (o *GroupedQueryResponse) Redact()

Redact resets all sensitive fields to their zero value.

func (*GroupedQueryResponse) SetData 

func (o *GroupedQueryResponse) SetData(v []GroupedQueryResponseDataInner)

SetData sets field value

type GroupedQueryResponseDataInner 

type GroupedQueryResponseDataInner struct {
	Points               []Point `json:"points"`
	AdditionalProperties map[string]interface{}
}

GroupedQueryResponseDataInner struct for GroupedQueryResponseDataInner

func NewGroupedQueryResponseDataInner 

func NewGroupedQueryResponseDataInner(points []Point) *GroupedQueryResponseDataInner

NewGroupedQueryResponseDataInner instantiates a new GroupedQueryResponseDataInner object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewGroupedQueryResponseDataInnerWithDefaults 

func NewGroupedQueryResponseDataInnerWithDefaults() *GroupedQueryResponseDataInner

NewGroupedQueryResponseDataInnerWithDefaults instantiates a new GroupedQueryResponseDataInner object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*GroupedQueryResponseDataInner) GetPoints 

func (o *GroupedQueryResponseDataInner) GetPoints() []Point

GetPoints returns the Points field value

func (*GroupedQueryResponseDataInner) GetPointsOk 

func (o *GroupedQueryResponseDataInner) GetPointsOk() ([]Point, bool)

GetPointsOk returns a tuple with the Points field value and a boolean to check if the value has been set.

func (GroupedQueryResponseDataInner) MarshalJSON 

func (o GroupedQueryResponseDataInner) MarshalJSON() ([]byte, error)

func (*GroupedQueryResponseDataInner) Redact 

func (o *GroupedQueryResponseDataInner) Redact()

Redact resets all sensitive fields to their zero value.

func (*GroupedQueryResponseDataInner) SetPoints 

func (o *GroupedQueryResponseDataInner) SetPoints(v []Point)

SetPoints sets field value

func (*GroupedQueryResponseDataInner) UnmarshalJSON 

func (o *GroupedQueryResponseDataInner) UnmarshalJSON(bytes []byte) (err error)

type LabelDescriptor 

type LabelDescriptor struct {
	// The description of the metric.
	Description string `json:"description"`
	// The key of the label.
	Key string `json:"key"`
	// Is this label included in the `/export` endpoint response?
	Exportable *bool `json:"exportable,omitempty"`
}

LabelDescriptor The description of a label.

func NewLabelDescriptor 

func NewLabelDescriptor(description string, key string) *LabelDescriptor

NewLabelDescriptor instantiates a new LabelDescriptor object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewLabelDescriptorWithDefaults 

func NewLabelDescriptorWithDefaults() *LabelDescriptor

NewLabelDescriptorWithDefaults instantiates a new LabelDescriptor object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*LabelDescriptor) GetDescription 

func (o *LabelDescriptor) GetDescription() string

GetDescription returns the Description field value

func (*LabelDescriptor) GetDescriptionOk 

func (o *LabelDescriptor) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value and a boolean to check if the value has been set.

func (*LabelDescriptor) GetExportable 

func (o *LabelDescriptor) GetExportable() bool

GetExportable returns the Exportable field value if set, zero value otherwise.

func (*LabelDescriptor) GetExportableOk 

func (o *LabelDescriptor) GetExportableOk() (*bool, bool)

GetExportableOk returns a tuple with the Exportable field value if set, nil otherwise and a boolean to check if the value has been set.

func (*LabelDescriptor) GetKey 

func (o *LabelDescriptor) GetKey() string

GetKey returns the Key field value

func (*LabelDescriptor) GetKeyOk 

func (o *LabelDescriptor) GetKeyOk() (*string, bool)

GetKeyOk returns a tuple with the Key field value and a boolean to check if the value has been set.

func (*LabelDescriptor) HasExportable 

func (o *LabelDescriptor) HasExportable() bool

HasExportable returns a boolean if a field has been set.

func (LabelDescriptor) MarshalJSON 

func (o LabelDescriptor) MarshalJSON() ([]byte, error)

func (*LabelDescriptor) Redact 

func (o *LabelDescriptor) Redact()

Redact resets all sensitive fields to their zero value.

func (*LabelDescriptor) SetDescription 

func (o *LabelDescriptor) SetDescription(v string)

SetDescription sets field value

func (*LabelDescriptor) SetExportable 

func (o *LabelDescriptor) SetExportable(v bool)

SetExportable gets a reference to the given bool and assigns it to the Exportable field.

func (*LabelDescriptor) SetKey 

func (o *LabelDescriptor) SetKey(v string)

SetKey sets field value 

type Links struct {
	// The next page of resources in a collection. The link is present only if the current document is part of a collection.
	Next *string `json:"next,omitempty"`
}

Links link information 

func NewLinks() *Links

NewLinks instantiates a new Links object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewLinksWithDefaults 

func NewLinksWithDefaults() *Links

NewLinksWithDefaults instantiates a new Links object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Links) GetNext 

func (o *Links) GetNext() string

GetNext returns the Next field value if set, zero value otherwise.

func (*Links) GetNextOk 

func (o *Links) GetNextOk() (*string, bool)

GetNextOk returns a tuple with the Next field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Links) HasNext 

func (o *Links) HasNext() bool

HasNext returns a boolean if a field has been set.

func (Links) MarshalJSON 

func (o Links) MarshalJSON() ([]byte, error)

func (*Links) Redact 

func (o *Links) Redact()

Redact resets all sensitive fields to their zero value.

func (*Links) SetNext 

func (o *Links) SetNext(v string)

SetNext gets a reference to the given string and assigns it to the Next field.

type ListMetricDescriptorsResponse 

type ListMetricDescriptorsResponse struct {
	// The metric descriptors for the specified dataset.
	Data  []MetricDescriptor `json:"data"`
	Meta  Meta               `json:"meta"`
	Links *Links             `json:"links,omitempty"`
}

ListMetricDescriptorsResponse The ListMetricDescriptors response.

func NewListMetricDescriptorsResponse 

func NewListMetricDescriptorsResponse(data []MetricDescriptor, meta Meta) *ListMetricDescriptorsResponse

NewListMetricDescriptorsResponse instantiates a new ListMetricDescriptorsResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewListMetricDescriptorsResponseWithDefaults 

func NewListMetricDescriptorsResponseWithDefaults() *ListMetricDescriptorsResponse

NewListMetricDescriptorsResponseWithDefaults instantiates a new ListMetricDescriptorsResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ListMetricDescriptorsResponse) GetData 

func (o *ListMetricDescriptorsResponse) GetData() []MetricDescriptor

GetData returns the Data field value

func (*ListMetricDescriptorsResponse) GetDataOk 

func (o *ListMetricDescriptorsResponse) GetDataOk() ([]MetricDescriptor, bool)

GetDataOk returns a tuple with the Data field value and a boolean to check if the value has been set. 

func (o *ListMetricDescriptorsResponse) GetLinks() Links

GetLinks returns the Links field value if set, zero value otherwise.

func (*ListMetricDescriptorsResponse) GetLinksOk 

func (o *ListMetricDescriptorsResponse) GetLinksOk() (*Links, bool)

GetLinksOk returns a tuple with the Links field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ListMetricDescriptorsResponse) GetMeta 

func (o *ListMetricDescriptorsResponse) GetMeta() Meta

GetMeta returns the Meta field value

func (*ListMetricDescriptorsResponse) GetMetaOk 

func (o *ListMetricDescriptorsResponse) GetMetaOk() (*Meta, bool)

GetMetaOk returns a tuple with the Meta field value and a boolean to check if the value has been set. 

func (o *ListMetricDescriptorsResponse) HasLinks() bool

HasLinks returns a boolean if a field has been set.

func (ListMetricDescriptorsResponse) MarshalJSON 

func (o ListMetricDescriptorsResponse) MarshalJSON() ([]byte, error)

func (*ListMetricDescriptorsResponse) Redact 

func (o *ListMetricDescriptorsResponse) Redact()

Redact resets all sensitive fields to their zero value.

func (*ListMetricDescriptorsResponse) SetData 

func (o *ListMetricDescriptorsResponse) SetData(v []MetricDescriptor)

SetData sets field value 

func (o *ListMetricDescriptorsResponse) SetLinks(v Links)

SetLinks gets a reference to the given Links and assigns it to the Links field.

func (*ListMetricDescriptorsResponse) SetMeta 

func (o *ListMetricDescriptorsResponse) SetMeta(v Meta)

SetMeta sets field value

type ListResourceDescriptorsResponse 

type ListResourceDescriptorsResponse struct {
	// The resource descriptors for the specified dataset.
	Data  []ResourceDescriptor `json:"data"`
	Meta  Meta                 `json:"meta"`
	Links *Links               `json:"links,omitempty"`
}

ListResourceDescriptorsResponse The list of resource descriptors for a dataset

func NewListResourceDescriptorsResponse 

func NewListResourceDescriptorsResponse(data []ResourceDescriptor, meta Meta) *ListResourceDescriptorsResponse

NewListResourceDescriptorsResponse instantiates a new ListResourceDescriptorsResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewListResourceDescriptorsResponseWithDefaults 

func NewListResourceDescriptorsResponseWithDefaults() *ListResourceDescriptorsResponse

NewListResourceDescriptorsResponseWithDefaults instantiates a new ListResourceDescriptorsResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ListResourceDescriptorsResponse) GetData 

func (o *ListResourceDescriptorsResponse) GetData() []ResourceDescriptor

GetData returns the Data field value

func (*ListResourceDescriptorsResponse) GetDataOk 

func (o *ListResourceDescriptorsResponse) GetDataOk() ([]ResourceDescriptor, bool)

GetDataOk returns a tuple with the Data field value and a boolean to check if the value has been set. 

func (o *ListResourceDescriptorsResponse) GetLinks() Links

GetLinks returns the Links field value if set, zero value otherwise.

func (*ListResourceDescriptorsResponse) GetLinksOk 

func (o *ListResourceDescriptorsResponse) GetLinksOk() (*Links, bool)

GetLinksOk returns a tuple with the Links field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ListResourceDescriptorsResponse) GetMeta 

func (o *ListResourceDescriptorsResponse) GetMeta() Meta

GetMeta returns the Meta field value

func (*ListResourceDescriptorsResponse) GetMetaOk 

func (o *ListResourceDescriptorsResponse) GetMetaOk() (*Meta, bool)

GetMetaOk returns a tuple with the Meta field value and a boolean to check if the value has been set. 

func (o *ListResourceDescriptorsResponse) HasLinks() bool

HasLinks returns a boolean if a field has been set.

func (ListResourceDescriptorsResponse) MarshalJSON 

func (o ListResourceDescriptorsResponse) MarshalJSON() ([]byte, error)

func (*ListResourceDescriptorsResponse) Redact 

func (o *ListResourceDescriptorsResponse) Redact()

Redact resets all sensitive fields to their zero value.

func (*ListResourceDescriptorsResponse) SetData 

func (o *ListResourceDescriptorsResponse) SetData(v []ResourceDescriptor)

SetData sets field value 

func (o *ListResourceDescriptorsResponse) SetLinks(v Links)

SetLinks gets a reference to the given Links and assigns it to the Links field.

func (*ListResourceDescriptorsResponse) SetMeta 

func (o *ListResourceDescriptorsResponse) SetMeta(v Meta)

SetMeta sets field value

type Meta 

type Meta struct {
	Pagination Pagination `json:"pagination"`
}

Meta Meta object

func NewMeta 

func NewMeta(pagination Pagination) *Meta

NewMeta instantiates a new Meta object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewMetaWithDefaults 

func NewMetaWithDefaults() *Meta

NewMetaWithDefaults instantiates a new Meta object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Meta) GetPagination 

func (o *Meta) GetPagination() Pagination

GetPagination returns the Pagination field value

func (*Meta) GetPaginationOk 

func (o *Meta) GetPaginationOk() (*Pagination, bool)

GetPaginationOk returns a tuple with the Pagination field value and a boolean to check if the value has been set.

func (Meta) MarshalJSON 

func (o Meta) MarshalJSON() ([]byte, error)

func (*Meta) Redact 

func (o *Meta) Redact()

Redact resets all sensitive fields to their zero value.

func (*Meta) SetPagination 

func (o *Meta) SetPagination(v Pagination)

SetPagination sets field value

type MetricDescriptor 

type MetricDescriptor struct {
	// The description of the metric.
	Description string `json:"description"`
	// Labels for filtering and aggregating this metric. For example, you can filter the `io.confluent.kafka.server/received_bytes` metric by the `topic` label.
	Labels []LabelDescriptor `json:"labels"`
	// The unique name of the metric, for example, `io.confluent.kafka.server/received_bytes`.
	Name string `json:"name"`
	// The unit that the metric value is reported in. Units follow the format described in [the Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html). For example, `By` for bytes and `By/s` for bytes per second.
	Unit string `json:"unit"`
	// The type of the measurement. The metric type follows the [OpenTelemetry](https://opentelemetry.io/) exposition format. * `GAUGE_(INT64|DOUBLE)`: An instantaneous measurement of a value.   Gauge metrics are implicitly averaged when aggregating over time. * `COUNTER_(INT64|DOUBLE)`: The count of occurrences in a _single (one minute) sampling   interval_ (unless otherwise stated in the metric description).   Counter metrics are implicitly summed when aggregating over time.
	Type string `json:"type"`
	// The support lifecycle stage for this metric: * `PREVIEW`: May change at any time * `GENERAL_AVAILABILITY`: Fully released and stable. Will not change without notice. * `DEPRECATED`: No longer supported. Will be removed in the future at the annouced date.
	LifecycleStage string `json:"lifecycle_stage"`
	// Is this metric included in the `/export` endpoint response?
	Exportable bool `json:"exportable"`
	// The resource types to which this metric pertains.
	Resources []string `json:"resources"`
}

MetricDescriptor Defines a metric type and its schema.

func NewMetricDescriptor 

func NewMetricDescriptor(description string, labels []LabelDescriptor, name string, unit string, type_ string, lifecycleStage string, exportable bool, resources []string) *MetricDescriptor

NewMetricDescriptor instantiates a new MetricDescriptor object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewMetricDescriptorWithDefaults 

func NewMetricDescriptorWithDefaults() *MetricDescriptor

NewMetricDescriptorWithDefaults instantiates a new MetricDescriptor object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*MetricDescriptor) GetDescription 

func (o *MetricDescriptor) GetDescription() string

GetDescription returns the Description field value

func (*MetricDescriptor) GetDescriptionOk 

func (o *MetricDescriptor) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value and a boolean to check if the value has been set.

func (*MetricDescriptor) GetExportable 

func (o *MetricDescriptor) GetExportable() bool

GetExportable returns the Exportable field value

func (*MetricDescriptor) GetExportableOk 

func (o *MetricDescriptor) GetExportableOk() (*bool, bool)

GetExportableOk returns a tuple with the Exportable field value and a boolean to check if the value has been set.

func (*MetricDescriptor) GetLabels 

func (o *MetricDescriptor) GetLabels() []LabelDescriptor

GetLabels returns the Labels field value

func (*MetricDescriptor) GetLabelsOk 

func (o *MetricDescriptor) GetLabelsOk() ([]LabelDescriptor, bool)

GetLabelsOk returns a tuple with the Labels field value and a boolean to check if the value has been set.

func (*MetricDescriptor) GetLifecycleStage 

func (o *MetricDescriptor) GetLifecycleStage() string

GetLifecycleStage returns the LifecycleStage field value

func (*MetricDescriptor) GetLifecycleStageOk 

func (o *MetricDescriptor) GetLifecycleStageOk() (*string, bool)

GetLifecycleStageOk returns a tuple with the LifecycleStage field value and a boolean to check if the value has been set.

func (*MetricDescriptor) GetName 

func (o *MetricDescriptor) GetName() string

GetName returns the Name field value

func (*MetricDescriptor) GetNameOk 

func (o *MetricDescriptor) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value and a boolean to check if the value has been set.

func (*MetricDescriptor) GetResources 

func (o *MetricDescriptor) GetResources() []string

GetResources returns the Resources field value

func (*MetricDescriptor) GetResourcesOk 

func (o *MetricDescriptor) GetResourcesOk() ([]string, bool)

GetResourcesOk returns a tuple with the Resources field value and a boolean to check if the value has been set.

func (*MetricDescriptor) GetType 

func (o *MetricDescriptor) GetType() string

GetType returns the Type field value

func (*MetricDescriptor) GetTypeOk 

func (o *MetricDescriptor) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value and a boolean to check if the value has been set.

func (*MetricDescriptor) GetUnit 

func (o *MetricDescriptor) GetUnit() string

GetUnit returns the Unit field value

func (*MetricDescriptor) GetUnitOk 

func (o *MetricDescriptor) GetUnitOk() (*string, bool)

GetUnitOk returns a tuple with the Unit field value and a boolean to check if the value has been set.

func (MetricDescriptor) MarshalJSON 

func (o MetricDescriptor) MarshalJSON() ([]byte, error)

func (*MetricDescriptor) Redact 

func (o *MetricDescriptor) Redact()

Redact resets all sensitive fields to their zero value.

func (*MetricDescriptor) SetDescription 

func (o *MetricDescriptor) SetDescription(v string)

SetDescription sets field value

func (*MetricDescriptor) SetExportable 

func (o *MetricDescriptor) SetExportable(v bool)

SetExportable sets field value

func (*MetricDescriptor) SetLabels 

func (o *MetricDescriptor) SetLabels(v []LabelDescriptor)

SetLabels sets field value

func (*MetricDescriptor) SetLifecycleStage 

func (o *MetricDescriptor) SetLifecycleStage(v string)

SetLifecycleStage sets field value

func (*MetricDescriptor) SetName 

func (o *MetricDescriptor) SetName(v string)

SetName sets field value

func (*MetricDescriptor) SetResources 

func (o *MetricDescriptor) SetResources(v []string)

SetResources sets field value

func (*MetricDescriptor) SetType 

func (o *MetricDescriptor) SetType(v string)

SetType sets field value

func (*MetricDescriptor) SetUnit 

func (o *MetricDescriptor) SetUnit(v string)

SetUnit sets field value

type NullableAggregation 

type NullableAggregation struct {
	// contains filtered or unexported fields
}

func NewNullableAggregation 

func NewNullableAggregation(val *Aggregation) *NullableAggregation

func (NullableAggregation) Get 

func (v NullableAggregation) Get() *Aggregation

func (NullableAggregation) IsSet 

func (v NullableAggregation) IsSet() bool

func (NullableAggregation) MarshalJSON 

func (v NullableAggregation) MarshalJSON() ([]byte, error)

func (*NullableAggregation) Set 

func (v *NullableAggregation) Set(val *Aggregation)

func (*NullableAggregation) UnmarshalJSON 

func (v *NullableAggregation) UnmarshalJSON(src []byte) error

func (*NullableAggregation) Unset 

func (v *NullableAggregation) Unset()

type NullableAggregationFunction 

type NullableAggregationFunction struct {
	// contains filtered or unexported fields
}

func NewNullableAggregationFunction 

func NewNullableAggregationFunction(val *AggregationFunction) *NullableAggregationFunction

func (NullableAggregationFunction) Get 

func (v NullableAggregationFunction) Get() *AggregationFunction

func (NullableAggregationFunction) IsSet 

func (v NullableAggregationFunction) IsSet() bool

func (NullableAggregationFunction) MarshalJSON 

func (v NullableAggregationFunction) MarshalJSON() ([]byte, error)

func (*NullableAggregationFunction) Set 

func (v *NullableAggregationFunction) Set(val *AggregationFunction)

func (*NullableAggregationFunction) UnmarshalJSON 

func (v *NullableAggregationFunction) UnmarshalJSON(src []byte) error

func (*NullableAggregationFunction) Unset 

func (v *NullableAggregationFunction) Unset()

type NullableAttributesRequest 

type NullableAttributesRequest struct {
	// contains filtered or unexported fields
}

func NewNullableAttributesRequest 

func NewNullableAttributesRequest(val *AttributesRequest) *NullableAttributesRequest

func (NullableAttributesRequest) Get 

func (v NullableAttributesRequest) Get() *AttributesRequest

func (NullableAttributesRequest) IsSet 

func (v NullableAttributesRequest) IsSet() bool

func (NullableAttributesRequest) MarshalJSON 

func (v NullableAttributesRequest) MarshalJSON() ([]byte, error)

func (*NullableAttributesRequest) Set 

func (v *NullableAttributesRequest) Set(val *AttributesRequest)

func (*NullableAttributesRequest) UnmarshalJSON 

func (v *NullableAttributesRequest) UnmarshalJSON(src []byte) error

func (*NullableAttributesRequest) Unset 

func (v *NullableAttributesRequest) Unset()

type NullableAttributesResponse 

type NullableAttributesResponse struct {
	// contains filtered or unexported fields
}

func NewNullableAttributesResponse 

func NewNullableAttributesResponse(val *AttributesResponse) *NullableAttributesResponse

func (NullableAttributesResponse) Get 

func (v NullableAttributesResponse) Get() *AttributesResponse

func (NullableAttributesResponse) IsSet 

func (v NullableAttributesResponse) IsSet() bool

func (NullableAttributesResponse) MarshalJSON 

func (v NullableAttributesResponse) MarshalJSON() ([]byte, error)

func (*NullableAttributesResponse) Set 

func (v *NullableAttributesResponse) Set(val *AttributesResponse)

func (*NullableAttributesResponse) UnmarshalJSON 

func (v *NullableAttributesResponse) UnmarshalJSON(src []byte) error

func (*NullableAttributesResponse) Unset 

func (v *NullableAttributesResponse) Unset()

type NullableBool 

type NullableBool struct {
	// contains filtered or unexported fields
}

func NewNullableBool 

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get 

func (v NullableBool) Get() *bool

func (NullableBool) IsSet 

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON 

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set 

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON 

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset 

func (v *NullableBool) Unset()

type NullableCompoundFilter 

type NullableCompoundFilter struct {
	// contains filtered or unexported fields
}

func NewNullableCompoundFilter 

func NewNullableCompoundFilter(val *CompoundFilter) *NullableCompoundFilter

func (NullableCompoundFilter) Get 

func (v NullableCompoundFilter) Get() *CompoundFilter

func (NullableCompoundFilter) IsSet 

func (v NullableCompoundFilter) IsSet() bool

func (NullableCompoundFilter) MarshalJSON 

func (v NullableCompoundFilter) MarshalJSON() ([]byte, error)

func (*NullableCompoundFilter) Set 

func (v *NullableCompoundFilter) Set(val *CompoundFilter)

func (*NullableCompoundFilter) UnmarshalJSON 

func (v *NullableCompoundFilter) UnmarshalJSON(src []byte) error

func (*NullableCompoundFilter) Unset 

func (v *NullableCompoundFilter) Unset()

type NullableErrorResponse 

type NullableErrorResponse struct {
	// contains filtered or unexported fields
}

func NewNullableErrorResponse 

func NewNullableErrorResponse(val *ErrorResponse) *NullableErrorResponse

func (NullableErrorResponse) Get 

func (v NullableErrorResponse) Get() *ErrorResponse

func (NullableErrorResponse) IsSet 

func (v NullableErrorResponse) IsSet() bool

func (NullableErrorResponse) MarshalJSON 

func (v NullableErrorResponse) MarshalJSON() ([]byte, error)

func (*NullableErrorResponse) Set 

func (v *NullableErrorResponse) Set(val *ErrorResponse)

func (*NullableErrorResponse) UnmarshalJSON 

func (v *NullableErrorResponse) UnmarshalJSON(src []byte) error

func (*NullableErrorResponse) Unset 

func (v *NullableErrorResponse) Unset()

type NullableErrorResponseErrorsInner 

type NullableErrorResponseErrorsInner struct {
	// contains filtered or unexported fields
}

func NewNullableErrorResponseErrorsInner 

func NewNullableErrorResponseErrorsInner(val *ErrorResponseErrorsInner) *NullableErrorResponseErrorsInner

func (NullableErrorResponseErrorsInner) Get 

func (v NullableErrorResponseErrorsInner) Get() *ErrorResponseErrorsInner

func (NullableErrorResponseErrorsInner) IsSet 

func (v NullableErrorResponseErrorsInner) IsSet() bool

func (NullableErrorResponseErrorsInner) MarshalJSON 

func (v NullableErrorResponseErrorsInner) MarshalJSON() ([]byte, error)

func (*NullableErrorResponseErrorsInner) Set 

func (v *NullableErrorResponseErrorsInner) Set(val *ErrorResponseErrorsInner)

func (*NullableErrorResponseErrorsInner) UnmarshalJSON 

func (v *NullableErrorResponseErrorsInner) UnmarshalJSON(src []byte) error

func (*NullableErrorResponseErrorsInner) Unset 

func (v *NullableErrorResponseErrorsInner) Unset()

type NullableFieldFilter 

type NullableFieldFilter struct {
	// contains filtered or unexported fields
}

func NewNullableFieldFilter 

func NewNullableFieldFilter(val *FieldFilter) *NullableFieldFilter

func (NullableFieldFilter) Get 

func (v NullableFieldFilter) Get() *FieldFilter

func (NullableFieldFilter) IsSet 

func (v NullableFieldFilter) IsSet() bool

func (NullableFieldFilter) MarshalJSON 

func (v NullableFieldFilter) MarshalJSON() ([]byte, error)

func (*NullableFieldFilter) Set 

func (v *NullableFieldFilter) Set(val *FieldFilter)

func (*NullableFieldFilter) UnmarshalJSON 

func (v *NullableFieldFilter) UnmarshalJSON(src []byte) error

func (*NullableFieldFilter) Unset 

func (v *NullableFieldFilter) Unset()

type NullableFieldFilterValue 

type NullableFieldFilterValue struct {
	// contains filtered or unexported fields
}

func NewNullableFieldFilterValue 

func NewNullableFieldFilterValue(val *FieldFilterValue) *NullableFieldFilterValue

func (NullableFieldFilterValue) Get 

func (v NullableFieldFilterValue) Get() *FieldFilterValue

func (NullableFieldFilterValue) IsSet 

func (v NullableFieldFilterValue) IsSet() bool

func (NullableFieldFilterValue) MarshalJSON 

func (v NullableFieldFilterValue) MarshalJSON() ([]byte, error)

func (*NullableFieldFilterValue) Set 

func (v *NullableFieldFilterValue) Set(val *FieldFilterValue)

func (*NullableFieldFilterValue) UnmarshalJSON 

func (v *NullableFieldFilterValue) UnmarshalJSON(src []byte) error

func (*NullableFieldFilterValue) Unset 

func (v *NullableFieldFilterValue) Unset()

type NullableFilter 

type NullableFilter struct {
	// contains filtered or unexported fields
}

func NewNullableFilter 

func NewNullableFilter(val *Filter) *NullableFilter

func (NullableFilter) Get 

func (v NullableFilter) Get() *Filter

func (NullableFilter) IsSet 

func (v NullableFilter) IsSet() bool

func (NullableFilter) MarshalJSON 

func (v NullableFilter) MarshalJSON() ([]byte, error)

func (*NullableFilter) Set 

func (v *NullableFilter) Set(val *Filter)

func (*NullableFilter) UnmarshalJSON 

func (v *NullableFilter) UnmarshalJSON(src []byte) error

func (*NullableFilter) Unset 

func (v *NullableFilter) Unset()

type NullableFlatQueryResponse 

type NullableFlatQueryResponse struct {
	// contains filtered or unexported fields
}

func NewNullableFlatQueryResponse 

func NewNullableFlatQueryResponse(val *FlatQueryResponse) *NullableFlatQueryResponse

func (NullableFlatQueryResponse) Get 

func (v NullableFlatQueryResponse) Get() *FlatQueryResponse

func (NullableFlatQueryResponse) IsSet 

func (v NullableFlatQueryResponse) IsSet() bool

func (NullableFlatQueryResponse) MarshalJSON 

func (v NullableFlatQueryResponse) MarshalJSON() ([]byte, error)

func (*NullableFlatQueryResponse) Set 

func (v *NullableFlatQueryResponse) Set(val *FlatQueryResponse)

func (*NullableFlatQueryResponse) UnmarshalJSON 

func (v *NullableFlatQueryResponse) UnmarshalJSON(src []byte) error

func (*NullableFlatQueryResponse) Unset 

func (v *NullableFlatQueryResponse) Unset()

type NullableFloat32 

type NullableFloat32 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat32 

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get 

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet 

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON 

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set 

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON 

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset 

func (v *NullableFloat32) Unset()

type NullableFloat64 

type NullableFloat64 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat64 

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get 

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet 

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON 

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set 

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON 

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset 

func (v *NullableFloat64) Unset()

type NullableGranularity 

type NullableGranularity struct {
	// contains filtered or unexported fields
}

func NewNullableGranularity 

func NewNullableGranularity(val *Granularity) *NullableGranularity

func (NullableGranularity) Get 

func (v NullableGranularity) Get() *Granularity

func (NullableGranularity) IsSet 

func (v NullableGranularity) IsSet() bool

func (NullableGranularity) MarshalJSON 

func (v NullableGranularity) MarshalJSON() ([]byte, error)

func (*NullableGranularity) Set 

func (v *NullableGranularity) Set(val *Granularity)

func (*NullableGranularity) UnmarshalJSON 

func (v *NullableGranularity) UnmarshalJSON(src []byte) error

func (*NullableGranularity) Unset 

func (v *NullableGranularity) Unset()

type NullableGroupedQueryResponse 

type NullableGroupedQueryResponse struct {
	// contains filtered or unexported fields
}

func NewNullableGroupedQueryResponse 

func NewNullableGroupedQueryResponse(val *GroupedQueryResponse) *NullableGroupedQueryResponse

func (NullableGroupedQueryResponse) Get 

func (v NullableGroupedQueryResponse) Get() *GroupedQueryResponse

func (NullableGroupedQueryResponse) IsSet 

func (v NullableGroupedQueryResponse) IsSet() bool

func (NullableGroupedQueryResponse) MarshalJSON 

func (v NullableGroupedQueryResponse) MarshalJSON() ([]byte, error)

func (*NullableGroupedQueryResponse) Set 

func (v *NullableGroupedQueryResponse) Set(val *GroupedQueryResponse)

func (*NullableGroupedQueryResponse) UnmarshalJSON 

func (v *NullableGroupedQueryResponse) UnmarshalJSON(src []byte) error

func (*NullableGroupedQueryResponse) Unset 

func (v *NullableGroupedQueryResponse) Unset()

type NullableGroupedQueryResponseDataInner 

type NullableGroupedQueryResponseDataInner struct {
	// contains filtered or unexported fields
}

func NewNullableGroupedQueryResponseDataInner 

func NewNullableGroupedQueryResponseDataInner(val *GroupedQueryResponseDataInner) *NullableGroupedQueryResponseDataInner

func (NullableGroupedQueryResponseDataInner) Get 

func (v NullableGroupedQueryResponseDataInner) Get() *GroupedQueryResponseDataInner

func (NullableGroupedQueryResponseDataInner) IsSet 

func (v NullableGroupedQueryResponseDataInner) IsSet() bool

func (NullableGroupedQueryResponseDataInner) MarshalJSON 

func (v NullableGroupedQueryResponseDataInner) MarshalJSON() ([]byte, error)

func (*NullableGroupedQueryResponseDataInner) Set 

func (v *NullableGroupedQueryResponseDataInner) Set(val *GroupedQueryResponseDataInner)

func (*NullableGroupedQueryResponseDataInner) UnmarshalJSON 

func (v *NullableGroupedQueryResponseDataInner) UnmarshalJSON(src []byte) error

func (*NullableGroupedQueryResponseDataInner) Unset 

func (v *NullableGroupedQueryResponseDataInner) Unset()

type NullableInt 

type NullableInt struct {
	// contains filtered or unexported fields
}

func NewNullableInt 

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get 

func (v NullableInt) Get() *int

func (NullableInt) IsSet 

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON 

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set 

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON 

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset 

func (v *NullableInt) Unset()

type NullableInt32 

type NullableInt32 struct {
	// contains filtered or unexported fields
}

func NewNullableInt32 

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get 

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet 

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON 

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set 

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON 

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset 

func (v *NullableInt32) Unset()

type NullableInt64 

type NullableInt64 struct {
	// contains filtered or unexported fields
}

func NewNullableInt64 

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get 

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet 

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON 

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set 

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON 

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset 

func (v *NullableInt64) Unset()

type NullableLabelDescriptor 

type NullableLabelDescriptor struct {
	// contains filtered or unexported fields
}

func NewNullableLabelDescriptor 

func NewNullableLabelDescriptor(val *LabelDescriptor) *NullableLabelDescriptor

func (NullableLabelDescriptor) Get 

func (v NullableLabelDescriptor) Get() *LabelDescriptor

func (NullableLabelDescriptor) IsSet 

func (v NullableLabelDescriptor) IsSet() bool

func (NullableLabelDescriptor) MarshalJSON 

func (v NullableLabelDescriptor) MarshalJSON() ([]byte, error)

func (*NullableLabelDescriptor) Set 

func (v *NullableLabelDescriptor) Set(val *LabelDescriptor)

func (*NullableLabelDescriptor) UnmarshalJSON 

func (v *NullableLabelDescriptor) UnmarshalJSON(src []byte) error

func (*NullableLabelDescriptor) Unset 

func (v *NullableLabelDescriptor) Unset()
type NullableLinks struct {
	// contains filtered or unexported fields
}
func NewNullableLinks(val *Links) *NullableLinks

func (NullableLinks) Get 

func (v NullableLinks) Get() *Links

func (NullableLinks) IsSet 

func (v NullableLinks) IsSet() bool

func (NullableLinks) MarshalJSON 

func (v NullableLinks) MarshalJSON() ([]byte, error)

func (*NullableLinks) Set 

func (v *NullableLinks) Set(val *Links)

func (*NullableLinks) UnmarshalJSON 

func (v *NullableLinks) UnmarshalJSON(src []byte) error

func (*NullableLinks) Unset 

func (v *NullableLinks) Unset()

type NullableListMetricDescriptorsResponse 

type NullableListMetricDescriptorsResponse struct {
	// contains filtered or unexported fields
}

func NewNullableListMetricDescriptorsResponse 

func NewNullableListMetricDescriptorsResponse(val *ListMetricDescriptorsResponse) *NullableListMetricDescriptorsResponse

func (NullableListMetricDescriptorsResponse) Get 

func (v NullableListMetricDescriptorsResponse) Get() *ListMetricDescriptorsResponse

func (NullableListMetricDescriptorsResponse) IsSet 

func (v NullableListMetricDescriptorsResponse) IsSet() bool

func (NullableListMetricDescriptorsResponse) MarshalJSON 

func (v NullableListMetricDescriptorsResponse) MarshalJSON() ([]byte, error)

func (*NullableListMetricDescriptorsResponse) Set 

func (v *NullableListMetricDescriptorsResponse) Set(val *ListMetricDescriptorsResponse)

func (*NullableListMetricDescriptorsResponse) UnmarshalJSON 

func (v *NullableListMetricDescriptorsResponse) UnmarshalJSON(src []byte) error

func (*NullableListMetricDescriptorsResponse) Unset 

func (v *NullableListMetricDescriptorsResponse) Unset()

type NullableListResourceDescriptorsResponse 

type NullableListResourceDescriptorsResponse struct {
	// contains filtered or unexported fields
}

func NewNullableListResourceDescriptorsResponse 

func NewNullableListResourceDescriptorsResponse(val *ListResourceDescriptorsResponse) *NullableListResourceDescriptorsResponse

func (NullableListResourceDescriptorsResponse) Get 

func (v NullableListResourceDescriptorsResponse) Get() *ListResourceDescriptorsResponse

func (NullableListResourceDescriptorsResponse) IsSet 

func (v NullableListResourceDescriptorsResponse) IsSet() bool

func (NullableListResourceDescriptorsResponse) MarshalJSON 

func (v NullableListResourceDescriptorsResponse) MarshalJSON() ([]byte, error)

func (*NullableListResourceDescriptorsResponse) Set 

func (v *NullableListResourceDescriptorsResponse) Set(val *ListResourceDescriptorsResponse)

func (*NullableListResourceDescriptorsResponse) UnmarshalJSON 

func (v *NullableListResourceDescriptorsResponse) UnmarshalJSON(src []byte) error

func (*NullableListResourceDescriptorsResponse) Unset 

func (v *NullableListResourceDescriptorsResponse) Unset()

type NullableMeta 

type NullableMeta struct {
	// contains filtered or unexported fields
}

func NewNullableMeta 

func NewNullableMeta(val *Meta) *NullableMeta

func (NullableMeta) Get 

func (v NullableMeta) Get() *Meta

func (NullableMeta) IsSet 

func (v NullableMeta) IsSet() bool

func (NullableMeta) MarshalJSON 

func (v NullableMeta) MarshalJSON() ([]byte, error)

func (*NullableMeta) Set 

func (v *NullableMeta) Set(val *Meta)

func (*NullableMeta) UnmarshalJSON 

func (v *NullableMeta) UnmarshalJSON(src []byte) error

func (*NullableMeta) Unset 

func (v *NullableMeta) Unset()

type NullableMetricDescriptor 

type NullableMetricDescriptor struct {
	// contains filtered or unexported fields
}

func NewNullableMetricDescriptor 

func NewNullableMetricDescriptor(val *MetricDescriptor) *NullableMetricDescriptor

func (NullableMetricDescriptor) Get 

func (v NullableMetricDescriptor) Get() *MetricDescriptor

func (NullableMetricDescriptor) IsSet 

func (v NullableMetricDescriptor) IsSet() bool

func (NullableMetricDescriptor) MarshalJSON 

func (v NullableMetricDescriptor) MarshalJSON() ([]byte, error)

func (*NullableMetricDescriptor) Set 

func (v *NullableMetricDescriptor) Set(val *MetricDescriptor)

func (*NullableMetricDescriptor) UnmarshalJSON 

func (v *NullableMetricDescriptor) UnmarshalJSON(src []byte) error

func (*NullableMetricDescriptor) Unset 

func (v *NullableMetricDescriptor) Unset()

type NullableOrderBy 

type NullableOrderBy struct {
	// contains filtered or unexported fields
}

func NewNullableOrderBy 

func NewNullableOrderBy(val *OrderBy) *NullableOrderBy

func (NullableOrderBy) Get 

func (v NullableOrderBy) Get() *OrderBy

func (NullableOrderBy) IsSet 

func (v NullableOrderBy) IsSet() bool

func (NullableOrderBy) MarshalJSON 

func (v NullableOrderBy) MarshalJSON() ([]byte, error)

func (*NullableOrderBy) Set 

func (v *NullableOrderBy) Set(val *OrderBy)

func (*NullableOrderBy) UnmarshalJSON 

func (v *NullableOrderBy) UnmarshalJSON(src []byte) error

func (*NullableOrderBy) Unset 

func (v *NullableOrderBy) Unset()

type NullablePagination 

type NullablePagination struct {
	// contains filtered or unexported fields
}

func NewNullablePagination 

func NewNullablePagination(val *Pagination) *NullablePagination

func (NullablePagination) Get 

func (v NullablePagination) Get() *Pagination

func (NullablePagination) IsSet 

func (v NullablePagination) IsSet() bool

func (NullablePagination) MarshalJSON 

func (v NullablePagination) MarshalJSON() ([]byte, error)

func (*NullablePagination) Set 

func (v *NullablePagination) Set(val *Pagination)

func (*NullablePagination) UnmarshalJSON 

func (v *NullablePagination) UnmarshalJSON(src []byte) error

func (*NullablePagination) Unset 

func (v *NullablePagination) Unset()

type NullablePoint 

type NullablePoint struct {
	// contains filtered or unexported fields
}

func NewNullablePoint 

func NewNullablePoint(val *Point) *NullablePoint

func (NullablePoint) Get 

func (v NullablePoint) Get() *Point

func (NullablePoint) IsSet 

func (v NullablePoint) IsSet() bool

func (NullablePoint) MarshalJSON 

func (v NullablePoint) MarshalJSON() ([]byte, error)

func (*NullablePoint) Set 

func (v *NullablePoint) Set(val *Point)

func (*NullablePoint) UnmarshalJSON 

func (v *NullablePoint) UnmarshalJSON(src []byte) error

func (*NullablePoint) Unset 

func (v *NullablePoint) Unset()

type NullableQueryRequest 

type NullableQueryRequest struct {
	// contains filtered or unexported fields
}

func NewNullableQueryRequest 

func NewNullableQueryRequest(val *QueryRequest) *NullableQueryRequest

func (NullableQueryRequest) Get 

func (v NullableQueryRequest) Get() *QueryRequest

func (NullableQueryRequest) IsSet 

func (v NullableQueryRequest) IsSet() bool

func (NullableQueryRequest) MarshalJSON 

func (v NullableQueryRequest) MarshalJSON() ([]byte, error)

func (*NullableQueryRequest) Set 

func (v *NullableQueryRequest) Set(val *QueryRequest)

func (*NullableQueryRequest) UnmarshalJSON 

func (v *NullableQueryRequest) UnmarshalJSON(src []byte) error

func (*NullableQueryRequest) Unset 

func (v *NullableQueryRequest) Unset()

type NullableQueryResponse 

type NullableQueryResponse struct {
	// contains filtered or unexported fields
}

func NewNullableQueryResponse 

func NewNullableQueryResponse(val *QueryResponse) *NullableQueryResponse

func (NullableQueryResponse) Get 

func (v NullableQueryResponse) Get() *QueryResponse

func (NullableQueryResponse) IsSet 

func (v NullableQueryResponse) IsSet() bool

func (NullableQueryResponse) MarshalJSON 

func (v NullableQueryResponse) MarshalJSON() ([]byte, error)

func (*NullableQueryResponse) Set 

func (v *NullableQueryResponse) Set(val *QueryResponse)

func (*NullableQueryResponse) UnmarshalJSON 

func (v *NullableQueryResponse) UnmarshalJSON(src []byte) error

func (*NullableQueryResponse) Unset 

func (v *NullableQueryResponse) Unset()

type NullableResourceDescriptor 

type NullableResourceDescriptor struct {
	// contains filtered or unexported fields
}

func NewNullableResourceDescriptor 

func NewNullableResourceDescriptor(val *ResourceDescriptor) *NullableResourceDescriptor

func (NullableResourceDescriptor) Get 

func (v NullableResourceDescriptor) Get() *ResourceDescriptor

func (NullableResourceDescriptor) IsSet 

func (v NullableResourceDescriptor) IsSet() bool

func (NullableResourceDescriptor) MarshalJSON 

func (v NullableResourceDescriptor) MarshalJSON() ([]byte, error)

func (*NullableResourceDescriptor) Set 

func (v *NullableResourceDescriptor) Set(val *ResourceDescriptor)

func (*NullableResourceDescriptor) UnmarshalJSON 

func (v *NullableResourceDescriptor) UnmarshalJSON(src []byte) error

func (*NullableResourceDescriptor) Unset 

func (v *NullableResourceDescriptor) Unset()

type NullableResponseFormat 

type NullableResponseFormat struct {
	// contains filtered or unexported fields
}

func NewNullableResponseFormat 

func NewNullableResponseFormat(val *ResponseFormat) *NullableResponseFormat

func (NullableResponseFormat) Get 

func (v NullableResponseFormat) Get() *ResponseFormat

func (NullableResponseFormat) IsSet 

func (v NullableResponseFormat) IsSet() bool

func (NullableResponseFormat) MarshalJSON 

func (v NullableResponseFormat) MarshalJSON() ([]byte, error)

func (*NullableResponseFormat) Set 

func (v *NullableResponseFormat) Set(val *ResponseFormat)

func (*NullableResponseFormat) UnmarshalJSON 

func (v *NullableResponseFormat) UnmarshalJSON(src []byte) error

func (*NullableResponseFormat) Unset 

func (v *NullableResponseFormat) Unset()

type NullableString 

type NullableString struct {
	// contains filtered or unexported fields
}

func NewNullableString 

func NewNullableString(val *string) *NullableString

func (NullableString) Get 

func (v NullableString) Get() *string

func (NullableString) IsSet 

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON 

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set 

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON 

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset 

func (v *NullableString) Unset()

type NullableTime 

type NullableTime struct {
	// contains filtered or unexported fields
}

func NewNullableTime 

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get 

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet 

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON 

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set 

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON 

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset 

func (v *NullableTime) Unset()

type NullableUnaryFilter 

type NullableUnaryFilter struct {
	// contains filtered or unexported fields
}

func NewNullableUnaryFilter 

func NewNullableUnaryFilter(val *UnaryFilter) *NullableUnaryFilter

func (NullableUnaryFilter) Get 

func (v NullableUnaryFilter) Get() *UnaryFilter

func (NullableUnaryFilter) IsSet 

func (v NullableUnaryFilter) IsSet() bool

func (NullableUnaryFilter) MarshalJSON 

func (v NullableUnaryFilter) MarshalJSON() ([]byte, error)

func (*NullableUnaryFilter) Set 

func (v *NullableUnaryFilter) Set(val *UnaryFilter)

func (*NullableUnaryFilter) UnmarshalJSON 

func (v *NullableUnaryFilter) UnmarshalJSON(src []byte) error

func (*NullableUnaryFilter) Unset 

func (v *NullableUnaryFilter) Unset()

type NullableV1MetricsDatasetAttributesPostRequest 

type NullableV1MetricsDatasetAttributesPostRequest struct {
	// contains filtered or unexported fields
}

func NewNullableV1MetricsDatasetAttributesPostRequest 

func NewNullableV1MetricsDatasetAttributesPostRequest(val *V1MetricsDatasetAttributesPostRequest) *NullableV1MetricsDatasetAttributesPostRequest

func (NullableV1MetricsDatasetAttributesPostRequest) Get 

func (v NullableV1MetricsDatasetAttributesPostRequest) Get() *V1MetricsDatasetAttributesPostRequest

func (NullableV1MetricsDatasetAttributesPostRequest) IsSet 

func (v NullableV1MetricsDatasetAttributesPostRequest) IsSet() bool

func (NullableV1MetricsDatasetAttributesPostRequest) MarshalJSON 

func (v NullableV1MetricsDatasetAttributesPostRequest) MarshalJSON() ([]byte, error)

func (*NullableV1MetricsDatasetAttributesPostRequest) Set 

func (v *NullableV1MetricsDatasetAttributesPostRequest) Set(val *V1MetricsDatasetAttributesPostRequest)

func (*NullableV1MetricsDatasetAttributesPostRequest) UnmarshalJSON 

func (v *NullableV1MetricsDatasetAttributesPostRequest) UnmarshalJSON(src []byte) error

func (*NullableV1MetricsDatasetAttributesPostRequest) Unset 

func (v *NullableV1MetricsDatasetAttributesPostRequest) Unset()

type OrderBy 

type OrderBy struct {
	Metric string               `json:"metric"`
	Agg    *AggregationFunction `json:"agg,omitempty"`
	Order  *string              `json:"order,omitempty"`
}

OrderBy struct for OrderBy

func NewOrderBy 

func NewOrderBy(metric string) *OrderBy

NewOrderBy instantiates a new OrderBy object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewOrderByWithDefaults 

func NewOrderByWithDefaults() *OrderBy

NewOrderByWithDefaults instantiates a new OrderBy object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*OrderBy) GetAgg 

func (o *OrderBy) GetAgg() AggregationFunction

GetAgg returns the Agg field value if set, zero value otherwise.

func (*OrderBy) GetAggOk 

func (o *OrderBy) GetAggOk() (*AggregationFunction, bool)

GetAggOk returns a tuple with the Agg field value if set, nil otherwise and a boolean to check if the value has been set.

func (*OrderBy) GetMetric 

func (o *OrderBy) GetMetric() string

GetMetric returns the Metric field value

func (*OrderBy) GetMetricOk 

func (o *OrderBy) GetMetricOk() (*string, bool)

GetMetricOk returns a tuple with the Metric field value and a boolean to check if the value has been set.

func (*OrderBy) GetOrder 

func (o *OrderBy) GetOrder() string

GetOrder returns the Order field value if set, zero value otherwise.

func (*OrderBy) GetOrderOk 

func (o *OrderBy) GetOrderOk() (*string, bool)

GetOrderOk returns a tuple with the Order field value if set, nil otherwise and a boolean to check if the value has been set.

func (*OrderBy) HasAgg 

func (o *OrderBy) HasAgg() bool

HasAgg returns a boolean if a field has been set.

func (*OrderBy) HasOrder 

func (o *OrderBy) HasOrder() bool

HasOrder returns a boolean if a field has been set.

func (OrderBy) MarshalJSON 

func (o OrderBy) MarshalJSON() ([]byte, error)

func (*OrderBy) Redact 

func (o *OrderBy) Redact()

Redact resets all sensitive fields to their zero value.

func (*OrderBy) SetAgg 

func (o *OrderBy) SetAgg(v AggregationFunction)

SetAgg gets a reference to the given AggregationFunction and assigns it to the Agg field.

func (*OrderBy) SetMetric 

func (o *OrderBy) SetMetric(v string)

SetMetric sets field value

func (*OrderBy) SetOrder 

func (o *OrderBy) SetOrder(v string)

SetOrder gets a reference to the given string and assigns it to the Order field.

type Pagination 

type Pagination struct {
	// The page size requested by the user.
	PageSize int32 `json:"page_size"`
	// The total number of items, if the total size can be determined in advance; otherwise, `total_size` is not included.
	TotalSize *int32 `json:"total_size,omitempty"`
	// An opaque token that you use to get the next page of results.
	NextPageToken *string `json:"next_page_token,omitempty"`
}

Pagination The pagination information.

func NewPagination 

func NewPagination(pageSize int32) *Pagination

NewPagination instantiates a new Pagination object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewPaginationWithDefaults 

func NewPaginationWithDefaults() *Pagination

NewPaginationWithDefaults instantiates a new Pagination object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Pagination) GetNextPageToken 

func (o *Pagination) GetNextPageToken() string

GetNextPageToken returns the NextPageToken field value if set, zero value otherwise.

func (*Pagination) GetNextPageTokenOk 

func (o *Pagination) GetNextPageTokenOk() (*string, bool)

GetNextPageTokenOk returns a tuple with the NextPageToken field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Pagination) GetPageSize 

func (o *Pagination) GetPageSize() int32

GetPageSize returns the PageSize field value

func (*Pagination) GetPageSizeOk 

func (o *Pagination) GetPageSizeOk() (*int32, bool)

GetPageSizeOk returns a tuple with the PageSize field value and a boolean to check if the value has been set.

func (*Pagination) GetTotalSize 

func (o *Pagination) GetTotalSize() int32

GetTotalSize returns the TotalSize field value if set, zero value otherwise.

func (*Pagination) GetTotalSizeOk 

func (o *Pagination) GetTotalSizeOk() (*int32, bool)

GetTotalSizeOk returns a tuple with the TotalSize field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Pagination) HasNextPageToken 

func (o *Pagination) HasNextPageToken() bool

HasNextPageToken returns a boolean if a field has been set.

func (*Pagination) HasTotalSize 

func (o *Pagination) HasTotalSize() bool

HasTotalSize returns a boolean if a field has been set.

func (Pagination) MarshalJSON 

func (o Pagination) MarshalJSON() ([]byte, error)

func (*Pagination) Redact 

func (o *Pagination) Redact()

Redact resets all sensitive fields to their zero value.

func (*Pagination) SetNextPageToken 

func (o *Pagination) SetNextPageToken(v string)

SetNextPageToken gets a reference to the given string and assigns it to the NextPageToken field.

func (*Pagination) SetPageSize 

func (o *Pagination) SetPageSize(v int32)

SetPageSize sets field value

func (*Pagination) SetTotalSize 

func (o *Pagination) SetTotalSize(v int32)

SetTotalSize gets a reference to the given int32 and assigns it to the TotalSize field.

type Point 

type Point struct {
	// The timestamp for this time bucket, aligned to UTC boundaries.
	Timestamp time.Time `json:"timestamp"`
	// The value for the requested aggregation for this time bucket.
	Value                float32 `json:"value"`
	AdditionalProperties map[string]interface{}
}

Point struct for Point

func NewPoint 

func NewPoint(timestamp time.Time, value float32) *Point

NewPoint instantiates a new Point object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewPointWithDefaults 

func NewPointWithDefaults() *Point

NewPointWithDefaults instantiates a new Point object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Point) GetTimestamp 

func (o *Point) GetTimestamp() time.Time

GetTimestamp returns the Timestamp field value

func (*Point) GetTimestampOk 

func (o *Point) GetTimestampOk() (*time.Time, bool)

GetTimestampOk returns a tuple with the Timestamp field value and a boolean to check if the value has been set.

func (*Point) GetValue 

func (o *Point) GetValue() float32

GetValue returns the Value field value

func (*Point) GetValueOk 

func (o *Point) GetValueOk() (*float32, bool)

GetValueOk returns a tuple with the Value field value and a boolean to check if the value has been set.

func (Point) MarshalJSON 

func (o Point) MarshalJSON() ([]byte, error)

func (*Point) Redact 

func (o *Point) Redact()

Redact resets all sensitive fields to their zero value.

func (*Point) SetTimestamp 

func (o *Point) SetTimestamp(v time.Time)

SetTimestamp sets field value

func (*Point) SetValue 

func (o *Point) SetValue(v float32)

SetValue sets field value

func (*Point) UnmarshalJSON 

func (o *Point) UnmarshalJSON(bytes []byte) (err error)

type QueryRequest 

type QueryRequest struct {
	// Specifies which metrics to query and the aggregation operator to apply across the `group_by` labels. **Currently, only one aggregation per request is supported.**
	Aggregations []Aggregation `json:"aggregations"`
	// Specifies how data gets bucketed by label(s); see [here](#section/Object-Model/Labels) on using labels for grouping query results.
	GroupBy     []string    `json:"group_by,omitempty"`
	Granularity Granularity `json:"granularity"`
	Filter      *Filter     `json:"filter,omitempty"`
	// Sort ordering for result groups. **Only valid for `granularity: \"ALL\"`.** If not specified, defaults to the first `aggregation` in descending order.  Note that this ordering applies to the groups. Within a group (or for ungrouped results), data points are always ordered by `timestamp` in descending order.
	OrderBy []OrderBy `json:"order_by,omitempty"`
	// Defines the time range(s) that the query runs over. A time range is an ISO-8601 interval.  The keyword `now` can be used in place of a timestamp to refer to the current time. Offset and truncation modifiers can be also be applied to the `now` expression:  | Modifier | Syntax | Examples | | --- | --- | --- | | Offset | `(+\\|-)<amount>(m\\|h\\|d)` | `-2m` (minus 2 minutes)<br/>`-1h` (minus 1 hour) | | Truncation | `\\|(m\\|h\\|d)` | `\\|m` (round down to start of minute)<br/>`\\|h` (round down to start of hour) |  All hour/day truncation is performed against the UTC timezone.  If `now` is `2020-01-01T02:13:27Z`, some examples are: * `now-2m|m`: `now` minus 2 minutes, truncated to start of minute. <br/>Resolves to `2020-01-01T02:11:00Z` * `now|h`: `now` truncated to start of hour. <br/>Resolves to `2020-01-01T02:00:00Z` * `now-1d|d`: `now` minus 1 day, truncated to start of day. <br/>Resolves to `2019-12-31T00:00:00Z`  When using `now`, it is recommended to apply a negative offset to avoid incomplete data (see [metric availability delays](#section/Client-Considerations-and-Best-Practices/Metric-Data-Latency)) and align to minute boundaries (e.g. `now-2m|m`).
	Intervals []string `json:"intervals"`
	// The maximum number of _groups_ to return. The maximum number of data points in the response is equal to `limit * (interval / granularity)`. For example, with an interval of 1 day, granularity of `PT1H`, and limit of `2` there will be a maximum of 48 data points in the response (24 for each group).
	Limit  *int32          `json:"limit,omitempty"`
	Format *ResponseFormat `json:"format,omitempty"`
}

QueryRequest struct for QueryRequest

func NewQueryRequest 

func NewQueryRequest(aggregations []Aggregation, granularity Granularity, intervals []string) *QueryRequest

NewQueryRequest instantiates a new QueryRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewQueryRequestWithDefaults 

func NewQueryRequestWithDefaults() *QueryRequest

NewQueryRequestWithDefaults instantiates a new QueryRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*QueryRequest) GetAggregations 

func (o *QueryRequest) GetAggregations() []Aggregation

GetAggregations returns the Aggregations field value

func (*QueryRequest) GetAggregationsOk 

func (o *QueryRequest) GetAggregationsOk() ([]Aggregation, bool)

GetAggregationsOk returns a tuple with the Aggregations field value and a boolean to check if the value has been set.

func (*QueryRequest) GetFilter 

func (o *QueryRequest) GetFilter() Filter

GetFilter returns the Filter field value if set, zero value otherwise.

func (*QueryRequest) GetFilterOk 

func (o *QueryRequest) GetFilterOk() (*Filter, bool)

GetFilterOk returns a tuple with the Filter field value if set, nil otherwise and a boolean to check if the value has been set.

func (*QueryRequest) GetFormat 

func (o *QueryRequest) GetFormat() ResponseFormat

GetFormat returns the Format field value if set, zero value otherwise.

func (*QueryRequest) GetFormatOk 

func (o *QueryRequest) GetFormatOk() (*ResponseFormat, bool)

GetFormatOk returns a tuple with the Format field value if set, nil otherwise and a boolean to check if the value has been set.

func (*QueryRequest) GetGranularity 

func (o *QueryRequest) GetGranularity() Granularity

GetGranularity returns the Granularity field value

func (*QueryRequest) GetGranularityOk 

func (o *QueryRequest) GetGranularityOk() (*Granularity, bool)

GetGranularityOk returns a tuple with the Granularity field value and a boolean to check if the value has been set.

func (*QueryRequest) GetGroupBy 

func (o *QueryRequest) GetGroupBy() []string

GetGroupBy returns the GroupBy field value if set, zero value otherwise.

func (*QueryRequest) GetGroupByOk 

func (o *QueryRequest) GetGroupByOk() ([]string, bool)

GetGroupByOk returns a tuple with the GroupBy field value if set, nil otherwise and a boolean to check if the value has been set.

func (*QueryRequest) GetIntervals 

func (o *QueryRequest) GetIntervals() []string

GetIntervals returns the Intervals field value

func (*QueryRequest) GetIntervalsOk 

func (o *QueryRequest) GetIntervalsOk() ([]string, bool)

GetIntervalsOk returns a tuple with the Intervals field value and a boolean to check if the value has been set.

func (*QueryRequest) GetLimit 

func (o *QueryRequest) GetLimit() int32

GetLimit returns the Limit field value if set, zero value otherwise.

func (*QueryRequest) GetLimitOk 

func (o *QueryRequest) GetLimitOk() (*int32, bool)

GetLimitOk returns a tuple with the Limit field value if set, nil otherwise and a boolean to check if the value has been set.

func (*QueryRequest) GetOrderBy 

func (o *QueryRequest) GetOrderBy() []OrderBy

GetOrderBy returns the OrderBy field value if set, zero value otherwise.

func (*QueryRequest) GetOrderByOk 

func (o *QueryRequest) GetOrderByOk() ([]OrderBy, bool)

GetOrderByOk returns a tuple with the OrderBy field value if set, nil otherwise and a boolean to check if the value has been set.

func (*QueryRequest) HasFilter 

func (o *QueryRequest) HasFilter() bool

HasFilter returns a boolean if a field has been set.

func (*QueryRequest) HasFormat 

func (o *QueryRequest) HasFormat() bool

HasFormat returns a boolean if a field has been set.

func (*QueryRequest) HasGroupBy 

func (o *QueryRequest) HasGroupBy() bool

HasGroupBy returns a boolean if a field has been set.

func (*QueryRequest) HasLimit 

func (o *QueryRequest) HasLimit() bool

HasLimit returns a boolean if a field has been set.

func (*QueryRequest) HasOrderBy 

func (o *QueryRequest) HasOrderBy() bool

HasOrderBy returns a boolean if a field has been set.

func (QueryRequest) MarshalJSON 

func (o QueryRequest) MarshalJSON() ([]byte, error)

func (*QueryRequest) Redact 

func (o *QueryRequest) Redact()

Redact resets all sensitive fields to their zero value.

func (*QueryRequest) SetAggregations 

func (o *QueryRequest) SetAggregations(v []Aggregation)

SetAggregations sets field value

func (*QueryRequest) SetFilter 

func (o *QueryRequest) SetFilter(v Filter)

SetFilter gets a reference to the given Filter and assigns it to the Filter field.

func (*QueryRequest) SetFormat 

func (o *QueryRequest) SetFormat(v ResponseFormat)

SetFormat gets a reference to the given ResponseFormat and assigns it to the Format field.

func (*QueryRequest) SetGranularity 

func (o *QueryRequest) SetGranularity(v Granularity)

SetGranularity sets field value

func (*QueryRequest) SetGroupBy 

func (o *QueryRequest) SetGroupBy(v []string)

SetGroupBy gets a reference to the given []string and assigns it to the GroupBy field.

func (*QueryRequest) SetIntervals 

func (o *QueryRequest) SetIntervals(v []string)

SetIntervals sets field value

func (*QueryRequest) SetLimit 

func (o *QueryRequest) SetLimit(v int32)

SetLimit gets a reference to the given int32 and assigns it to the Limit field.

func (*QueryRequest) SetOrderBy 

func (o *QueryRequest) SetOrderBy(v []OrderBy)

SetOrderBy gets a reference to the given []OrderBy and assigns it to the OrderBy field.

type QueryResponse 

type QueryResponse struct {
	FlatQueryResponse    *FlatQueryResponse
	GroupedQueryResponse *GroupedQueryResponse
}

QueryResponse - struct for QueryResponse

func FlatQueryResponseAsQueryResponse 

func FlatQueryResponseAsQueryResponse(v *FlatQueryResponse) QueryResponse

FlatQueryResponseAsQueryResponse is a convenience function that returns FlatQueryResponse wrapped in QueryResponse

func GroupedQueryResponseAsQueryResponse 

func GroupedQueryResponseAsQueryResponse(v *GroupedQueryResponse) QueryResponse

GroupedQueryResponseAsQueryResponse is a convenience function that returns GroupedQueryResponse wrapped in QueryResponse

func (*QueryResponse) GetActualInstance 

func (obj *QueryResponse) GetActualInstance() interface{}

Get the actual instance

func (QueryResponse) MarshalJSON 

func (src QueryResponse) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON

func (*QueryResponse) UnmarshalJSON 

func (dst *QueryResponse) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one of the pointers in the struct

type ResourceDescriptor 

type ResourceDescriptor struct {
	// A named type for a resource (e.g. `kafka`, `connector`).
	Type string `json:"type"`
	// The description of the resource.
	Description string `json:"description"`
	// Labels for the resource. Resource labels can be used for filtering and aggregating metrics associated with a resource.
	Labels []LabelDescriptor `json:"labels"`
}

ResourceDescriptor A Resource represents the entity producing metrics. For example: a Kafka cluster a Kafka Connector, etc.

func NewResourceDescriptor 

func NewResourceDescriptor(type_ string, description string, labels []LabelDescriptor) *ResourceDescriptor

NewResourceDescriptor instantiates a new ResourceDescriptor object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewResourceDescriptorWithDefaults 

func NewResourceDescriptorWithDefaults() *ResourceDescriptor

NewResourceDescriptorWithDefaults instantiates a new ResourceDescriptor object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ResourceDescriptor) GetDescription 

func (o *ResourceDescriptor) GetDescription() string

GetDescription returns the Description field value

func (*ResourceDescriptor) GetDescriptionOk 

func (o *ResourceDescriptor) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value and a boolean to check if the value has been set.

func (*ResourceDescriptor) GetLabels 

func (o *ResourceDescriptor) GetLabels() []LabelDescriptor

GetLabels returns the Labels field value

func (*ResourceDescriptor) GetLabelsOk 

func (o *ResourceDescriptor) GetLabelsOk() ([]LabelDescriptor, bool)

GetLabelsOk returns a tuple with the Labels field value and a boolean to check if the value has been set.

func (*ResourceDescriptor) GetType 

func (o *ResourceDescriptor) GetType() string

GetType returns the Type field value

func (*ResourceDescriptor) GetTypeOk 

func (o *ResourceDescriptor) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value and a boolean to check if the value has been set.

func (ResourceDescriptor) MarshalJSON 

func (o ResourceDescriptor) MarshalJSON() ([]byte, error)

func (*ResourceDescriptor) Redact 

func (o *ResourceDescriptor) Redact()

Redact resets all sensitive fields to their zero value.

func (*ResourceDescriptor) SetDescription 

func (o *ResourceDescriptor) SetDescription(v string)

SetDescription sets field value

func (*ResourceDescriptor) SetLabels 

func (o *ResourceDescriptor) SetLabels(v []LabelDescriptor)

SetLabels sets field value

func (*ResourceDescriptor) SetType 

func (o *ResourceDescriptor) SetType(v string)

SetType sets field value

type ResponseFormat 

type ResponseFormat string

ResponseFormat Desired response format for query results. * `FLAT` (default): Each item in the response `data` array represents a data point in the timeseries. Each data point contains the `timestamp`, metric aggregation `value` and attributes for the `group_by` labels. * `GROUPED`: Each item in the response `data` array represents a group. Each group contains attributes for the `group_by` labels and an array of `points` for the metric aggregation timeseries. **Only allowed when `group_by` is non-empty.** Please see the response schema and accompanying examples for more details. 

const (
	FLAT    ResponseFormat = "FLAT"
	GROUPED ResponseFormat = "GROUPED"
)

List of ResponseFormat

func NewResponseFormatFromValue 

func NewResponseFormatFromValue(v string) (*ResponseFormat, error)

NewResponseFormatFromValue returns a pointer to a valid ResponseFormat for the value passed as argument, or an error if the value passed is not allowed by the enum

func (ResponseFormat) IsValid 

func (v ResponseFormat) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (ResponseFormat) Ptr 

func (v ResponseFormat) Ptr() *ResponseFormat

Ptr returns reference to ResponseFormat value

func (*ResponseFormat) UnmarshalJSON 

func (v *ResponseFormat) UnmarshalJSON(src []byte) error

type ServerConfiguration 

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations 

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL 

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type UnaryFilter 

type UnaryFilter struct {
	Op     string `json:"op"`
	Filter Filter `json:"filter"`
}

UnaryFilter struct for UnaryFilter

func NewUnaryFilter 

func NewUnaryFilter(op string, filter Filter) *UnaryFilter

NewUnaryFilter instantiates a new UnaryFilter object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewUnaryFilterWithDefaults 

func NewUnaryFilterWithDefaults() *UnaryFilter

NewUnaryFilterWithDefaults instantiates a new UnaryFilter object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*UnaryFilter) GetFilter 

func (o *UnaryFilter) GetFilter() Filter

GetFilter returns the Filter field value

func (*UnaryFilter) GetFilterOk 

func (o *UnaryFilter) GetFilterOk() (*Filter, bool)

GetFilterOk returns a tuple with the Filter field value and a boolean to check if the value has been set.

func (*UnaryFilter) GetOp 

func (o *UnaryFilter) GetOp() string

GetOp returns the Op field value

func (*UnaryFilter) GetOpOk 

func (o *UnaryFilter) GetOpOk() (*string, bool)

GetOpOk returns a tuple with the Op field value and a boolean to check if the value has been set.

func (UnaryFilter) MarshalJSON 

func (o UnaryFilter) MarshalJSON() ([]byte, error)

func (*UnaryFilter) Redact 

func (o *UnaryFilter) Redact()

Redact resets all sensitive fields to their zero value.

func (*UnaryFilter) SetFilter 

func (o *UnaryFilter) SetFilter(v Filter)

SetFilter sets field value

func (*UnaryFilter) SetOp 

func (o *UnaryFilter) SetOp(v string)

SetOp sets field value

type V1MetricsDatasetAttributesPostRequest 

type V1MetricsDatasetAttributesPostRequest struct {
	// The metric that the label values are enumerated for.
	Metric string `json:"metric"`
	// The label(s) that the values are enumerated for.
	GroupBy []string `json:"group_by"`
	Filter  *Filter  `json:"filter,omitempty"`
	// Defines the time range(s) for which available metrics will be listed. A time range is an ISO-8601 interval. When unspecified, the value defaults to the last hour before the request was made
	Intervals []string `json:"intervals,omitempty"`
	Limit     *int32   `json:"limit,omitempty"`
}

V1MetricsDatasetAttributesPostRequest struct for V1MetricsDatasetAttributesPostRequest

func NewV1MetricsDatasetAttributesPostRequest 

func NewV1MetricsDatasetAttributesPostRequest(metric string, groupBy []string) *V1MetricsDatasetAttributesPostRequest

NewV1MetricsDatasetAttributesPostRequest instantiates a new V1MetricsDatasetAttributesPostRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewV1MetricsDatasetAttributesPostRequestWithDefaults 

func NewV1MetricsDatasetAttributesPostRequestWithDefaults() *V1MetricsDatasetAttributesPostRequest

NewV1MetricsDatasetAttributesPostRequestWithDefaults instantiates a new V1MetricsDatasetAttributesPostRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*V1MetricsDatasetAttributesPostRequest) GetFilter 

func (o *V1MetricsDatasetAttributesPostRequest) GetFilter() Filter

GetFilter returns the Filter field value if set, zero value otherwise.

func (*V1MetricsDatasetAttributesPostRequest) GetFilterOk 

func (o *V1MetricsDatasetAttributesPostRequest) GetFilterOk() (*Filter, bool)

GetFilterOk returns a tuple with the Filter field value if set, nil otherwise and a boolean to check if the value has been set.

func (*V1MetricsDatasetAttributesPostRequest) GetGroupBy 

func (o *V1MetricsDatasetAttributesPostRequest) GetGroupBy() []string

GetGroupBy returns the GroupBy field value

func (*V1MetricsDatasetAttributesPostRequest) GetGroupByOk 

func (o *V1MetricsDatasetAttributesPostRequest) GetGroupByOk() ([]string, bool)

GetGroupByOk returns a tuple with the GroupBy field value and a boolean to check if the value has been set.

func (*V1MetricsDatasetAttributesPostRequest) GetIntervals 

func (o *V1MetricsDatasetAttributesPostRequest) GetIntervals() []string

GetIntervals returns the Intervals field value if set, zero value otherwise.

func (*V1MetricsDatasetAttributesPostRequest) GetIntervalsOk 

func (o *V1MetricsDatasetAttributesPostRequest) GetIntervalsOk() ([]string, bool)

GetIntervalsOk returns a tuple with the Intervals field value if set, nil otherwise and a boolean to check if the value has been set.

func (*V1MetricsDatasetAttributesPostRequest) GetLimit 

func (o *V1MetricsDatasetAttributesPostRequest) GetLimit() int32

GetLimit returns the Limit field value if set, zero value otherwise.

func (*V1MetricsDatasetAttributesPostRequest) GetLimitOk 

func (o *V1MetricsDatasetAttributesPostRequest) GetLimitOk() (*int32, bool)

GetLimitOk returns a tuple with the Limit field value if set, nil otherwise and a boolean to check if the value has been set.

func (*V1MetricsDatasetAttributesPostRequest) GetMetric 

func (o *V1MetricsDatasetAttributesPostRequest) GetMetric() string

GetMetric returns the Metric field value

func (*V1MetricsDatasetAttributesPostRequest) GetMetricOk 

func (o *V1MetricsDatasetAttributesPostRequest) GetMetricOk() (*string, bool)

GetMetricOk returns a tuple with the Metric field value and a boolean to check if the value has been set.

func (*V1MetricsDatasetAttributesPostRequest) HasFilter 

func (o *V1MetricsDatasetAttributesPostRequest) HasFilter() bool

HasFilter returns a boolean if a field has been set.

func (*V1MetricsDatasetAttributesPostRequest) HasIntervals 

func (o *V1MetricsDatasetAttributesPostRequest) HasIntervals() bool

HasIntervals returns a boolean if a field has been set.

func (*V1MetricsDatasetAttributesPostRequest) HasLimit 

func (o *V1MetricsDatasetAttributesPostRequest) HasLimit() bool

HasLimit returns a boolean if a field has been set.

func (V1MetricsDatasetAttributesPostRequest) MarshalJSON 

func (o V1MetricsDatasetAttributesPostRequest) MarshalJSON() ([]byte, error)

func (*V1MetricsDatasetAttributesPostRequest) Redact 

func (o *V1MetricsDatasetAttributesPostRequest) Redact()

Redact resets all sensitive fields to their zero value.

func (*V1MetricsDatasetAttributesPostRequest) SetFilter 

func (o *V1MetricsDatasetAttributesPostRequest) SetFilter(v Filter)

SetFilter gets a reference to the given Filter and assigns it to the Filter field.

func (*V1MetricsDatasetAttributesPostRequest) SetGroupBy 

func (o *V1MetricsDatasetAttributesPostRequest) SetGroupBy(v []string)

SetGroupBy sets field value

func (*V1MetricsDatasetAttributesPostRequest) SetIntervals 

func (o *V1MetricsDatasetAttributesPostRequest) SetIntervals(v []string)

SetIntervals gets a reference to the given []string and assigns it to the Intervals field.

func (*V1MetricsDatasetAttributesPostRequest) SetLimit 

func (o *V1MetricsDatasetAttributesPostRequest) SetLimit(v int32)

SetLimit gets a reference to the given int32 and assigns it to the Limit field.

func (*V1MetricsDatasetAttributesPostRequest) SetMetric 

func (o *V1MetricsDatasetAttributesPostRequest) SetMetric(v string)

SetMetric sets field value

type Version1Api 

type Version1Api interface {

	/*
		V1MetricsDatasetAttributesPost Query label values

		Enumerates label values for a single metric.


		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@param dataset The dataset to query.
		@return ApiV1MetricsDatasetAttributesPostRequest

		Deprecated
	*/
	V1MetricsDatasetAttributesPost(ctx context.Context, dataset string) ApiV1MetricsDatasetAttributesPostRequest

	// V1MetricsDatasetAttributesPostExecute executes the request
	//  @return AttributesResponse
	// Deprecated
	V1MetricsDatasetAttributesPostExecute(r ApiV1MetricsDatasetAttributesPostRequest) (*AttributesResponse, *http.Response, error)

	/*
		V1MetricsDatasetDescriptorsGet List all metric descriptors

		Lists all the metric descriptors for a dataset.

	A metric descriptor represents metadata for a metric, including its data type and labels.
	This metadata is provided programmatically to enable clients to dynamically adjust as new
	metrics are added to the dataset, rather than hardcoding metric names in client code.


		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@param dataset The dataset to list metric descriptors for. Currently the only supported dataset name is `cloud`. See [here](#section/Object-Model/Datasets).
		@return ApiV1MetricsDatasetDescriptorsGetRequest

		Deprecated
	*/
	V1MetricsDatasetDescriptorsGet(ctx context.Context, dataset string) ApiV1MetricsDatasetDescriptorsGetRequest

	// V1MetricsDatasetDescriptorsGetExecute executes the request
	//  @return ListMetricDescriptorsResponse
	// Deprecated
	V1MetricsDatasetDescriptorsGetExecute(r ApiV1MetricsDatasetDescriptorsGetRequest) (*ListMetricDescriptorsResponse, *http.Response, error)

	/*
		V1MetricsDatasetQueryPost Query metric values

		Queries metrics in a dataset.

		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@param dataset The dataset to query. Currently the only supported dataset name is `cloud`. See [here](#section/Object-Model/Datasets).
		@return ApiV1MetricsDatasetQueryPostRequest

		Deprecated
	*/
	V1MetricsDatasetQueryPost(ctx context.Context, dataset string) ApiV1MetricsDatasetQueryPostRequest

	// V1MetricsDatasetQueryPostExecute executes the request
	//  @return QueryResponse
	// Deprecated
	V1MetricsDatasetQueryPostExecute(r ApiV1MetricsDatasetQueryPostRequest) (*QueryResponse, *http.Response, error)
}

type Version1ApiService 

type Version1ApiService service

Version1ApiService Version1Api service

func (*Version1ApiService) V1MetricsDatasetAttributesPost 

func (a *Version1ApiService) V1MetricsDatasetAttributesPost(ctx context.Context, dataset string) ApiV1MetricsDatasetAttributesPostRequest

V1MetricsDatasetAttributesPost Query label values

Enumerates label values for a single metric. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param dataset The dataset to query.
@return ApiV1MetricsDatasetAttributesPostRequest

Deprecated

func (*Version1ApiService) V1MetricsDatasetAttributesPostExecute 

func (a *Version1ApiService) V1MetricsDatasetAttributesPostExecute(r ApiV1MetricsDatasetAttributesPostRequest) (*AttributesResponse, *http.Response, error)

Execute executes the request 

@return AttributesResponse

Deprecated

func (*Version1ApiService) V1MetricsDatasetDescriptorsGet 

func (a *Version1ApiService) V1MetricsDatasetDescriptorsGet(ctx context.Context, dataset string) ApiV1MetricsDatasetDescriptorsGetRequest

V1MetricsDatasetDescriptorsGet List all metric descriptors

Lists all the metric descriptors for a dataset.

A metric descriptor represents metadata for a metric, including its data type and labels. This metadata is provided programmatically to enable clients to dynamically adjust as new metrics are added to the dataset, rather than hardcoding metric names in client code. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param dataset The dataset to list metric descriptors for. Currently the only supported dataset name is `cloud`. See [here](#section/Object-Model/Datasets).
@return ApiV1MetricsDatasetDescriptorsGetRequest

Deprecated

func (*Version1ApiService) V1MetricsDatasetDescriptorsGetExecute 

func (a *Version1ApiService) V1MetricsDatasetDescriptorsGetExecute(r ApiV1MetricsDatasetDescriptorsGetRequest) (*ListMetricDescriptorsResponse, *http.Response, error)

Execute executes the request 

@return ListMetricDescriptorsResponse

Deprecated

func (*Version1ApiService) V1MetricsDatasetQueryPost 

func (a *Version1ApiService) V1MetricsDatasetQueryPost(ctx context.Context, dataset string) ApiV1MetricsDatasetQueryPostRequest

V1MetricsDatasetQueryPost Query metric values

Queries metrics in a dataset. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param dataset The dataset to query. Currently the only supported dataset name is `cloud`. See [here](#section/Object-Model/Datasets).
@return ApiV1MetricsDatasetQueryPostRequest

Deprecated

func (*Version1ApiService) V1MetricsDatasetQueryPostExecute 

func (a *Version1ApiService) V1MetricsDatasetQueryPostExecute(r ApiV1MetricsDatasetQueryPostRequest) (*QueryResponse, *http.Response, error)

Execute executes the request 

@return QueryResponse

Deprecated

type Version2Api 

type Version2Api interface {

	/*
		V2MetricsDatasetAttributesPost Query label values

		Enumerates label values for a single metric.


		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@param dataset The dataset to query.
		@return ApiV2MetricsDatasetAttributesPostRequest
	*/
	V2MetricsDatasetAttributesPost(ctx context.Context, dataset string) ApiV2MetricsDatasetAttributesPostRequest

	// V2MetricsDatasetAttributesPostExecute executes the request
	//  @return AttributesResponse
	V2MetricsDatasetAttributesPostExecute(r ApiV2MetricsDatasetAttributesPostRequest) (*AttributesResponse, *http.Response, error)

	/*
		V2MetricsDatasetDescriptorsMetricsGet List metric descriptors

		Lists all the metric descriptors for a dataset.

	A metric descriptor represents metadata for a metric, including its data type and labels.
	This metadata is provided programmatically to enable clients to dynamically adjust as new
	metrics are added to the dataset, rather than hardcoding metric names in client code.


		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@param dataset The dataset to list metric descriptors for. Currently the only supported dataset name is `cloud`. See [here](#section/Object-Model/Datasets).
		@return ApiV2MetricsDatasetDescriptorsMetricsGetRequest
	*/
	V2MetricsDatasetDescriptorsMetricsGet(ctx context.Context, dataset string) ApiV2MetricsDatasetDescriptorsMetricsGetRequest

	// V2MetricsDatasetDescriptorsMetricsGetExecute executes the request
	//  @return ListMetricDescriptorsResponse
	V2MetricsDatasetDescriptorsMetricsGetExecute(r ApiV2MetricsDatasetDescriptorsMetricsGetRequest) (*ListMetricDescriptorsResponse, *http.Response, error)

	/*
		V2MetricsDatasetDescriptorsResourcesGet List resource descriptors

		Lists all the resource descriptors for a dataset.


		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@param dataset The dataset to list resource descriptors for. Currently the only supported dataset name is `cloud`. See [here](#section/Object-Model/Datasets).
		@return ApiV2MetricsDatasetDescriptorsResourcesGetRequest
	*/
	V2MetricsDatasetDescriptorsResourcesGet(ctx context.Context, dataset string) ApiV2MetricsDatasetDescriptorsResourcesGetRequest

	// V2MetricsDatasetDescriptorsResourcesGetExecute executes the request
	//  @return ListResourceDescriptorsResponse
	V2MetricsDatasetDescriptorsResourcesGetExecute(r ApiV2MetricsDatasetDescriptorsResourcesGetRequest) (*ListResourceDescriptorsResponse, *http.Response, error)

	/*
		V2MetricsDatasetExportGet Export metric values

		Export current metric values in [OpenMetrics format](https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md)
	or [Prometheus format](https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format),
	suitable for import into an external monitoring system. Returns the single most recent
	data point for each metric, for each distinct combination of labels.

	#### Supported datasets and metrics
	Only the `cloud` dataset is supported for this endpoint.

	Only a subset of metrics and labels from the dataset are included in the export response. To request
	a particular metric or label be added, please contact [Confluent Support](https://support.confluent.io).

	#### Metric translation
	Metric and label names are translated to adhere to [Prometheus restrictions](https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels).
	The `resource.` and `metric.` prefixes from label names are also dropped to simplify consumption in downstream systems.

	Counter metrics are classified as the Prometheus `gauge` type to conform to required semantics.
	> The `counter` type in Prometheus must be monotonically increasing, whereas Confluent
	Metrics API counters are represented as deltas.

	#### Timestamp offset
	To account for [metric data latency](#section/Client-Considerations-and-Best-Practices/Metric-Data-Latency),
	this endpoint returns metrics from the current timestamp minus a fixed offset. The current
	offset is 5 minutes rounded down to the start of the minute. For example, if a request is
	received at `12:06:41`, the returned metrics will have the timestamp `12:01:00` and represent the
	data for the interval `12:01:00` through `12:02:00` (exclusive).

	> **NOTE:** Confluent may choose to lengthen or shorten this offset based on operational
	considerations. _Doing so is considered a backwards-compatible change_.

	To accommodate this offset, the timestamps in the response should be honored when importing
	the metrics. For example, in prometheus this can be controlled using the `honor_timestamps`
	flag.

	#### Rate limits
	Since metrics are available at minute granularity, it is expected that clients scrape this
	endpoint at most once per minute. To allow for ad-hoc testing, the rate limit is enforced
	at hourly granularity. To accommodate retries, the rate limit is 80 requests per hour
	rather than 60 per hour.

	The rate limit is evaluated on a per-resource basis. For example, the following requests would
	each be allowed an 80-requests-per-hour rate:
	* `GET /v2/metrics/cloud/export?resource.kafka.id=lkc-1&resource.kafka.id=lkc-2`
	* `GET /v2/metrics/cloud/export?resource.kafka.id=lkc-3`

	Rate limits for this endpoint are also scoped to the authentication principal. This allows multiple systems
	to export metrics for the same resources by configuring each with a separate service account.

	If the rate limit is exceeded, the response body will include a message indicating which
	resource exceeded the limit.
	“`json
	{
	  "errors": [
	    {
	      "status": "429",
	      "detail": "Too many requests have been made for the following resources:
	kafka.id:lkc-12345. Please see the documentation for current rate limits."
	    }
	  ]
	}
	“`

	#### Example Prometheus scrape configuration
	Here is an example [prometheus configuration](https://prometheus.io/docs/prometheus/latest/configuration/configuration/)
	for scraping this endpoint:

	“`yaml
	scrape_configs:
	  - job_name: Confluent Cloud
	    scrape_interval: 1m
	    scrape_timeout: 1m
	    honor_timestamps: true
	    static_configs:
	      - targets:
	        - api.telemetry.confluent.cloud
	    scheme: https
	    basic_auth:
	      username: <Cloud API Key>
	      password: <Cloud API Secret>
	    metrics_path: /v2/metrics/cloud/export
	    params:
	      "resource.kafka.id":
	        - lkc-1
	        - lkc-2
	“`


		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@param dataset The dataset to export metrics for. Currently the only supported dataset name is `cloud`. See [here](#section/Object-Model/Datasets).
		@return ApiV2MetricsDatasetExportGetRequest
	*/
	V2MetricsDatasetExportGet(ctx context.Context, dataset string) ApiV2MetricsDatasetExportGetRequest

	// V2MetricsDatasetExportGetExecute executes the request
	//  @return string
	V2MetricsDatasetExportGetExecute(r ApiV2MetricsDatasetExportGetRequest) (string, *http.Response, error)

	/*
		V2MetricsDatasetQueryPost Query metric values

		Query for metric values in a dataset.


		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@param dataset The dataset to query. Currently the only supported dataset name is `cloud`. See [here](#section/Object-Model/Datasets).
		@return ApiV2MetricsDatasetQueryPostRequest
	*/
	V2MetricsDatasetQueryPost(ctx context.Context, dataset string) ApiV2MetricsDatasetQueryPostRequest

	// V2MetricsDatasetQueryPostExecute executes the request
	//  @return QueryResponse
	V2MetricsDatasetQueryPostExecute(r ApiV2MetricsDatasetQueryPostRequest) (*QueryResponse, *http.Response, error)
}

type Version2ApiService 

type Version2ApiService service

Version2ApiService Version2Api service

func (*Version2ApiService) V2MetricsDatasetAttributesPost 

func (a *Version2ApiService) V2MetricsDatasetAttributesPost(ctx context.Context, dataset string) ApiV2MetricsDatasetAttributesPostRequest

V2MetricsDatasetAttributesPost Query label values

Enumerates label values for a single metric. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param dataset The dataset to query.
@return ApiV2MetricsDatasetAttributesPostRequest

func (*Version2ApiService) V2MetricsDatasetAttributesPostExecute 

func (a *Version2ApiService) V2MetricsDatasetAttributesPostExecute(r ApiV2MetricsDatasetAttributesPostRequest) (*AttributesResponse, *http.Response, error)

Execute executes the request 

@return AttributesResponse

func (*Version2ApiService) V2MetricsDatasetDescriptorsMetricsGet 

func (a *Version2ApiService) V2MetricsDatasetDescriptorsMetricsGet(ctx context.Context, dataset string) ApiV2MetricsDatasetDescriptorsMetricsGetRequest

V2MetricsDatasetDescriptorsMetricsGet List metric descriptors

Lists all the metric descriptors for a dataset.

A metric descriptor represents metadata for a metric, including its data type and labels. This metadata is provided programmatically to enable clients to dynamically adjust as new metrics are added to the dataset, rather than hardcoding metric names in client code. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param dataset The dataset to list metric descriptors for. Currently the only supported dataset name is `cloud`. See [here](#section/Object-Model/Datasets).
@return ApiV2MetricsDatasetDescriptorsMetricsGetRequest

func (*Version2ApiService) V2MetricsDatasetDescriptorsMetricsGetExecute 

func (a *Version2ApiService) V2MetricsDatasetDescriptorsMetricsGetExecute(r ApiV2MetricsDatasetDescriptorsMetricsGetRequest) (*ListMetricDescriptorsResponse, *http.Response, error)

Execute executes the request 

@return ListMetricDescriptorsResponse

func (*Version2ApiService) V2MetricsDatasetDescriptorsResourcesGet 

func (a *Version2ApiService) V2MetricsDatasetDescriptorsResourcesGet(ctx context.Context, dataset string) ApiV2MetricsDatasetDescriptorsResourcesGetRequest

V2MetricsDatasetDescriptorsResourcesGet List resource descriptors

Lists all the resource descriptors for a dataset. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param dataset The dataset to list resource descriptors for. Currently the only supported dataset name is `cloud`. See [here](#section/Object-Model/Datasets).
@return ApiV2MetricsDatasetDescriptorsResourcesGetRequest

func (*Version2ApiService) V2MetricsDatasetDescriptorsResourcesGetExecute 

func (a *Version2ApiService) V2MetricsDatasetDescriptorsResourcesGetExecute(r ApiV2MetricsDatasetDescriptorsResourcesGetRequest) (*ListResourceDescriptorsResponse, *http.Response, error)

Execute executes the request 

@return ListResourceDescriptorsResponse

func (*Version2ApiService) V2MetricsDatasetExportGet 

func (a *Version2ApiService) V2MetricsDatasetExportGet(ctx context.Context, dataset string) ApiV2MetricsDatasetExportGetRequest

V2MetricsDatasetExportGet Export metric values

Export current metric values in [OpenMetrics format](https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md) or [Prometheus format](https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format), suitable for import into an external monitoring system. Returns the single most recent data point for each metric, for each distinct combination of labels.

#### Supported datasets and metrics Only the `cloud` dataset is supported for this endpoint.

Only a subset of metrics and labels from the dataset are included in the export response. To request a particular metric or label be added, please contact [Confluent Support](https://support.confluent.io).

#### Metric translation Metric and label names are translated to adhere to [Prometheus restrictions](https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). The `resource.` and `metric.` prefixes from label names are also dropped to simplify consumption in downstream systems.

Counter metrics are classified as the Prometheus `gauge` type to conform to required semantics. > The `counter` type in Prometheus must be monotonically increasing, whereas Confluent Metrics API counters are represented as deltas.

#### Timestamp offset To account for [metric data latency](#section/Client-Considerations-and-Best-Practices/Metric-Data-Latency), this endpoint returns metrics from the current timestamp minus a fixed offset. The current offset is 5 minutes rounded down to the start of the minute. For example, if a request is received at `12:06:41`, the returned metrics will have the timestamp `12:01:00` and represent the data for the interval `12:01:00` through `12:02:00` (exclusive).

> **NOTE:** Confluent may choose to lengthen or shorten this offset based on operational considerations. _Doing so is considered a backwards-compatible change_.

To accommodate this offset, the timestamps in the response should be honored when importing the metrics. For example, in prometheus this can be controlled using the `honor_timestamps` flag.

#### Rate limits Since metrics are available at minute granularity, it is expected that clients scrape this endpoint at most once per minute. To allow for ad-hoc testing, the rate limit is enforced at hourly granularity. To accommodate retries, the rate limit is 80 requests per hour rather than 60 per hour.

The rate limit is evaluated on a per-resource basis. For example, the following requests would each be allowed an 80-requests-per-hour rate: * `GET /v2/metrics/cloud/export?resource.kafka.id=lkc-1&resource.kafka.id=lkc-2` * `GET /v2/metrics/cloud/export?resource.kafka.id=lkc-3`

Rate limits for this endpoint are also scoped to the authentication principal. This allows multiple systems to export metrics for the same resources by configuring each with a separate service account.

If the rate limit is exceeded, the response body will include a message indicating which resource exceeded the limit. ```json 

{
  "errors": [
    {
      "status": "429",
      "detail": "Too many requests have been made for the following resources:

kafka.id:lkc-12345. Please see the documentation for current rate limits." 

    }
  ]
}

```

#### Example Prometheus scrape configuration Here is an example [prometheus configuration](https://prometheus.io/docs/prometheus/latest/configuration/configuration/) for scraping this endpoint:

```yaml scrape_configs:

  • job_name: Confluent Cloud scrape_interval: 1m scrape_timeout: 1m honor_timestamps: true static_configs:
  • targets:
  • api.telemetry.confluent.cloud scheme: https basic_auth: username: <Cloud API Key> password: <Cloud API Secret> metrics_path: /v2/metrics/cloud/export params: "resource.kafka.id":
  • lkc-1
  • lkc-2

``` 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param dataset The dataset to export metrics for. Currently the only supported dataset name is `cloud`. See [here](#section/Object-Model/Datasets).
@return ApiV2MetricsDatasetExportGetRequest

func (*Version2ApiService) V2MetricsDatasetExportGetExecute 

func (a *Version2ApiService) V2MetricsDatasetExportGetExecute(r ApiV2MetricsDatasetExportGetRequest) (string, *http.Response, error)

Execute executes the request 

@return string

func (*Version2ApiService) V2MetricsDatasetQueryPost 

func (a *Version2ApiService) V2MetricsDatasetQueryPost(ctx context.Context, dataset string) ApiV2MetricsDatasetQueryPostRequest

V2MetricsDatasetQueryPost Query metric values

Query for metric values in a dataset. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param dataset The dataset to query. Currently the only supported dataset name is `cloud`. See [here](#section/Object-Model/Datasets).
@return ApiV2MetricsDatasetQueryPostRequest

func (*Version2ApiService) V2MetricsDatasetQueryPostExecute 

func (a *Version2ApiService) V2MetricsDatasetQueryPostExecute(r ApiV2MetricsDatasetQueryPostRequest) (*QueryResponse, *http.Response, error)

Execute executes the request 

@return QueryResponse

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.