v2

package
v0.1.0 Latest Latest
Warning

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

Go to latest
Published: Feb 28, 2022 License: Apache-2.0 Imports: 22 Imported by: 0

README

Go API client for v2

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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.

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 sw "./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(), sw.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(), sw.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(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

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

Class Method HTTP request Description
AppliedQuotasQuotasV2Api GetQuotasV2AppliedQuota Get /quotas/v2/applied-quotas/{id} Read an Applied Quota
AppliedQuotasQuotasV2Api ListQuotasV2AppliedQuotas Get /quotas/v2/applied-quotas List of Applied Quotas
ScopesQuotasV2Api GetQuotasV2Scope Get /quotas/v2/scopes/{id} Read a Scope
ScopesQuotasV2Api ListQuotasV2Scopes Get /quotas/v2/scopes List of Scopes

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

api-framework-team@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")
)

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 {
	AppliedQuotasQuotasV2Api AppliedQuotasQuotasV2Api

	ScopesQuotasV2Api ScopesQuotasV2Api
	// contains filtered or unexported fields
}

APIClient manages communication with the Quotas Service API API v0.0.1-alpha0 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 ApiGetQuotasV2AppliedQuotaRequest

type ApiGetQuotasV2AppliedQuotaRequest struct {
	ApiService AppliedQuotasQuotasV2Api
	// contains filtered or unexported fields
}

func (ApiGetQuotasV2AppliedQuotaRequest) Environment

The environment ID the quota is associated with. This field is only required when retrieving a single quota and the scope of quota is \"ENVIRONMENT\" or \"NETWORK\" or \"KAFKA_CLUSTER\".

func (ApiGetQuotasV2AppliedQuotaRequest) Execute

func (ApiGetQuotasV2AppliedQuotaRequest) KafkaCluster

The kafka cluster ID the quota is associated with. This field is required only when the scope of quota is \"KAFKA_CLUSTER\".

func (ApiGetQuotasV2AppliedQuotaRequest) Network

The network ID the quota is associated with. This field is only required when retrieving a single quota and the scope of quota is \"NETWORK\".

type ApiGetQuotasV2ScopeRequest

type ApiGetQuotasV2ScopeRequest struct {
	ApiService ScopesQuotasV2Api
	// contains filtered or unexported fields
}

func (ApiGetQuotasV2ScopeRequest) Execute

type ApiListQuotasV2AppliedQuotasRequest

type ApiListQuotasV2AppliedQuotasRequest struct {
	ApiService AppliedQuotasQuotasV2Api
	// contains filtered or unexported fields
}

func (ApiListQuotasV2AppliedQuotasRequest) Environment

The environment ID the quota is associated with.

func (ApiListQuotasV2AppliedQuotasRequest) Execute

func (ApiListQuotasV2AppliedQuotasRequest) KafkaCluster

The kafka cluster ID the quota is associated with.

func (ApiListQuotasV2AppliedQuotasRequest) Network

The network ID the quota is associated with.

func (ApiListQuotasV2AppliedQuotasRequest) PageSize

A pagination size for collection requests.

func (ApiListQuotasV2AppliedQuotasRequest) PageToken

An opaque pagination token for collection requests.

func (ApiListQuotasV2AppliedQuotasRequest) QuotaCode

The quota code that this quota belongs to.

func (ApiListQuotasV2AppliedQuotasRequest) Scope

The applied scope the quota belongs to.

type ApiListQuotasV2ScopesRequest

type ApiListQuotasV2ScopesRequest struct {
	ApiService ScopesQuotasV2Api
	// contains filtered or unexported fields
}

func (ApiListQuotasV2ScopesRequest) Execute

func (ApiListQuotasV2ScopesRequest) PageSize

A pagination size for collection requests.

func (ApiListQuotasV2ScopesRequest) PageToken

An opaque pagination token for collection requests.

type AppliedQuotasQuotasV2Api

type AppliedQuotasQuotasV2Api interface {

	/*
		GetQuotasV2AppliedQuota Read an Applied Quota

		[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Quotas v2](https://img.shields.io/badge/-Request%20Access%20To%20Quotas%20v2-%23bc8540)](mailto:ccloud-api-access+quotas-v2-early-access@confluent.io?subject=Request%20to%20join%20quotas/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20quotas/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

	Make a request to read an applied quota.

		 @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 @param id The unique identifier for the applied quota.
		 @return ApiGetQuotasV2AppliedQuotaRequest
	*/
	GetQuotasV2AppliedQuota(ctx _context.Context, id string) ApiGetQuotasV2AppliedQuotaRequest

	// GetQuotasV2AppliedQuotaExecute executes the request
	//  @return QuotasV2AppliedQuota
	GetQuotasV2AppliedQuotaExecute(r ApiGetQuotasV2AppliedQuotaRequest) (QuotasV2AppliedQuota, *_nethttp.Response, error)

	/*
		ListQuotasV2AppliedQuotas List of Applied Quotas

		[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Quotas v2](https://img.shields.io/badge/-Request%20Access%20To%20Quotas%20v2-%23bc8540)](mailto:ccloud-api-access+quotas-v2-early-access@confluent.io?subject=Request%20to%20join%20quotas/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20quotas/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

	Retrieve a sorted, filtered, paginated list of all applied quotas.

	Shows all quotas for a given scope.


		 @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 @return ApiListQuotasV2AppliedQuotasRequest
	*/
	ListQuotasV2AppliedQuotas(ctx _context.Context) ApiListQuotasV2AppliedQuotasRequest

	// ListQuotasV2AppliedQuotasExecute executes the request
	//  @return QuotasV2AppliedQuotaList
	ListQuotasV2AppliedQuotasExecute(r ApiListQuotasV2AppliedQuotasRequest) (QuotasV2AppliedQuotaList, *_nethttp.Response, error)
}

type AppliedQuotasQuotasV2ApiService

type AppliedQuotasQuotasV2ApiService service

AppliedQuotasQuotasV2ApiService AppliedQuotasQuotasV2Api service

func (*AppliedQuotasQuotasV2ApiService) GetQuotasV2AppliedQuota

GetQuotasV2AppliedQuota Read an Applied Quota

[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Quotas v2](https://img.shields.io/badge/-Request%20Access%20To%20Quotas%20v2-%23bc8540)](mailto:ccloud-api-access+quotas-v2-early-access@confluent.io?subject=Request%20to%20join%20quotas/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20quotas/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

Make a request to read an applied quota.

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The unique identifier for the applied quota.
@return ApiGetQuotasV2AppliedQuotaRequest

func (*AppliedQuotasQuotasV2ApiService) GetQuotasV2AppliedQuotaExecute

Execute executes the request

@return QuotasV2AppliedQuota

func (*AppliedQuotasQuotasV2ApiService) ListQuotasV2AppliedQuotas

ListQuotasV2AppliedQuotas List of Applied Quotas

[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Quotas v2](https://img.shields.io/badge/-Request%20Access%20To%20Quotas%20v2-%23bc8540)](mailto:ccloud-api-access+quotas-v2-early-access@confluent.io?subject=Request%20to%20join%20quotas/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20quotas/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

Retrieve a sorted, filtered, paginated list of all applied quotas.

Shows all quotas for a given scope.

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiListQuotasV2AppliedQuotasRequest

func (*AppliedQuotasQuotasV2ApiService) ListQuotasV2AppliedQuotasExecute

Execute executes the request

@return QuotasV2AppliedQuotaList

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 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 Error

type Error 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 short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization.
	Title *string `json:"title,omitempty"`
	// A human-readable explanation specific to this occurrence of the problem.
	Detail *string      `json:"detail,omitempty"`
	Source *ErrorSource `json:"source,omitempty"`
}

Error Describes a particular error encountered while performing an operation.

func NewError

func NewError() *Error

NewError instantiates a new Error 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 NewErrorWithDefaults

func NewErrorWithDefaults() *Error

NewErrorWithDefaults instantiates a new Error 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 (*Error) GetCode

func (o *Error) GetCode() string

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

func (*Error) GetCodeOk

func (o *Error) 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 (*Error) GetDetail

func (o *Error) GetDetail() string

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

func (*Error) GetDetailOk

func (o *Error) 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 (*Error) GetId

func (o *Error) GetId() string

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

func (*Error) GetIdOk

func (o *Error) 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 (*Error) GetSource

func (o *Error) GetSource() ErrorSource

GetSource returns the Source field value if set, zero value otherwise.

func (*Error) GetSourceOk

func (o *Error) GetSourceOk() (*ErrorSource, bool)

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

func (*Error) GetStatus

func (o *Error) GetStatus() string

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

func (*Error) GetStatusOk

func (o *Error) 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 (*Error) GetTitle

func (o *Error) GetTitle() string

GetTitle returns the Title field value if set, zero value otherwise.

func (*Error) GetTitleOk

func (o *Error) GetTitleOk() (*string, bool)

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

func (*Error) HasCode

func (o *Error) HasCode() bool

HasCode returns a boolean if a field has been set.

func (*Error) HasDetail

func (o *Error) HasDetail() bool

HasDetail returns a boolean if a field has been set.

func (*Error) HasId

func (o *Error) HasId() bool

HasId returns a boolean if a field has been set.

func (*Error) HasSource

func (o *Error) HasSource() bool

HasSource returns a boolean if a field has been set.

func (*Error) HasStatus

func (o *Error) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (*Error) HasTitle

func (o *Error) HasTitle() bool

HasTitle returns a boolean if a field has been set.

func (Error) MarshalJSON

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

func (*Error) Redact

func (o *Error) Redact()

Redact resets all sensitive fields to their zero value.

func (*Error) SetCode

func (o *Error) SetCode(v string)

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

func (*Error) SetDetail

func (o *Error) SetDetail(v string)

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

func (*Error) SetId

func (o *Error) SetId(v string)

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

func (*Error) SetSource

func (o *Error) SetSource(v ErrorSource)

SetSource gets a reference to the given ErrorSource and assigns it to the Source field.

func (*Error) SetStatus

func (o *Error) SetStatus(v string)

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

func (*Error) SetTitle

func (o *Error) SetTitle(v string)

SetTitle gets a reference to the given string and assigns it to the Title field.

type ErrorSource

type ErrorSource struct {
	// A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/spec\" for a spec object, or \"/spec/title\" for a specific field].
	Pointer *string `json:"pointer,omitempty"`
	// A string indicating which query parameter caused the error.
	Parameter *string `json:"parameter,omitempty"`
}

ErrorSource If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it.

func NewErrorSource

func NewErrorSource() *ErrorSource

NewErrorSource instantiates a new ErrorSource 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 NewErrorSourceWithDefaults

func NewErrorSourceWithDefaults() *ErrorSource

NewErrorSourceWithDefaults instantiates a new ErrorSource 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 (*ErrorSource) GetParameter

func (o *ErrorSource) GetParameter() string

GetParameter returns the Parameter field value if set, zero value otherwise.

func (*ErrorSource) GetParameterOk

func (o *ErrorSource) GetParameterOk() (*string, bool)

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

func (*ErrorSource) GetPointer

func (o *ErrorSource) GetPointer() string

GetPointer returns the Pointer field value if set, zero value otherwise.

func (*ErrorSource) GetPointerOk

func (o *ErrorSource) GetPointerOk() (*string, bool)

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

func (*ErrorSource) HasParameter

func (o *ErrorSource) HasParameter() bool

HasParameter returns a boolean if a field has been set.

func (*ErrorSource) HasPointer

func (o *ErrorSource) HasPointer() bool

HasPointer returns a boolean if a field has been set.

func (ErrorSource) MarshalJSON

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

func (*ErrorSource) Redact

func (o *ErrorSource) Redact()

Redact resets all sensitive fields to their zero value.

func (*ErrorSource) SetParameter

func (o *ErrorSource) SetParameter(v string)

SetParameter gets a reference to the given string and assigns it to the Parameter field.

func (*ErrorSource) SetPointer

func (o *ErrorSource) SetPointer(v string)

SetPointer gets a reference to the given string and assigns it to the Pointer field.

type Failure

type Failure struct {
	// List of errors which caused this operation to fail
	Errors []Error `json:"errors"`
}

Failure Provides information about problems encountered while performing an operation.

func NewFailure

func NewFailure(errors []Error) *Failure

NewFailure instantiates a new Failure 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 NewFailureWithDefaults

func NewFailureWithDefaults() *Failure

NewFailureWithDefaults instantiates a new Failure 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 (*Failure) GetErrors

func (o *Failure) GetErrors() []Error

GetErrors returns the Errors field value

func (*Failure) GetErrorsOk

func (o *Failure) GetErrorsOk() (*[]Error, bool)

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

func (Failure) MarshalJSON

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

func (*Failure) Redact

func (o *Failure) Redact()

Redact resets all sensitive fields to their zero value.

func (*Failure) SetErrors

func (o *Failure) SetErrors(v []Error)

SetErrors 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 ListMeta

type ListMeta struct {
	// A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported.
	First NullableString `json:"first,omitempty"`
	// A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported.
	Last NullableString `json:"last,omitempty"`
	// A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported.
	Prev NullableString `json:"prev,omitempty"`
	// A link to the next page of results. If a response does not contain a next link, then there is no more data available.
	Next NullableString `json:"next,omitempty"`
	// Number of records in the full result set. This response may be paginated and have a smaller number of records.
	TotalSize *int32 `json:"total_size,omitempty"`
}

ListMeta ListMeta describes metadata that resource collections may have

func NewListMeta

func NewListMeta() *ListMeta

NewListMeta instantiates a new ListMeta 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 NewListMetaWithDefaults

func NewListMetaWithDefaults() *ListMeta

NewListMetaWithDefaults instantiates a new ListMeta 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 (*ListMeta) GetFirst

func (o *ListMeta) GetFirst() string

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

func (*ListMeta) GetFirstOk

func (o *ListMeta) GetFirstOk() (*string, bool)

GetFirstOk returns a tuple with the First 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 (*ListMeta) GetLast

func (o *ListMeta) GetLast() string

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

func (*ListMeta) GetLastOk

func (o *ListMeta) GetLastOk() (*string, bool)

GetLastOk returns a tuple with the Last 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 (*ListMeta) GetNext

func (o *ListMeta) GetNext() string

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

func (*ListMeta) GetNextOk

func (o *ListMeta) 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. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*ListMeta) GetPrev

func (o *ListMeta) GetPrev() string

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

func (*ListMeta) GetPrevOk

func (o *ListMeta) GetPrevOk() (*string, bool)

GetPrevOk returns a tuple with the Prev 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 (*ListMeta) GetTotalSize

func (o *ListMeta) GetTotalSize() int32

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

func (*ListMeta) GetTotalSizeOk

func (o *ListMeta) 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 (*ListMeta) HasFirst

func (o *ListMeta) HasFirst() bool

HasFirst returns a boolean if a field has been set.

func (*ListMeta) HasLast

func (o *ListMeta) HasLast() bool

HasLast returns a boolean if a field has been set.

func (*ListMeta) HasNext

func (o *ListMeta) HasNext() bool

HasNext returns a boolean if a field has been set.

func (*ListMeta) HasPrev

func (o *ListMeta) HasPrev() bool

HasPrev returns a boolean if a field has been set.

func (*ListMeta) HasTotalSize

func (o *ListMeta) HasTotalSize() bool

HasTotalSize returns a boolean if a field has been set.

func (ListMeta) MarshalJSON

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

func (*ListMeta) Redact

func (o *ListMeta) Redact()

Redact resets all sensitive fields to their zero value.

func (*ListMeta) SetFirst

func (o *ListMeta) SetFirst(v string)

SetFirst gets a reference to the given NullableString and assigns it to the First field.

func (*ListMeta) SetFirstNil

func (o *ListMeta) SetFirstNil()

SetFirstNil sets the value for First to be an explicit nil

func (*ListMeta) SetLast

func (o *ListMeta) SetLast(v string)

SetLast gets a reference to the given NullableString and assigns it to the Last field.

func (*ListMeta) SetLastNil

func (o *ListMeta) SetLastNil()

SetLastNil sets the value for Last to be an explicit nil

func (*ListMeta) SetNext

func (o *ListMeta) SetNext(v string)

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

func (*ListMeta) SetNextNil

func (o *ListMeta) SetNextNil()

SetNextNil sets the value for Next to be an explicit nil

func (*ListMeta) SetPrev

func (o *ListMeta) SetPrev(v string)

SetPrev gets a reference to the given NullableString and assigns it to the Prev field.

func (*ListMeta) SetPrevNil

func (o *ListMeta) SetPrevNil()

SetPrevNil sets the value for Prev to be an explicit nil

func (*ListMeta) SetTotalSize

func (o *ListMeta) SetTotalSize(v int32)

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

func (*ListMeta) UnsetFirst

func (o *ListMeta) UnsetFirst()

UnsetFirst ensures that no value is present for First, not even an explicit nil

func (*ListMeta) UnsetLast

func (o *ListMeta) UnsetLast()

UnsetLast ensures that no value is present for Last, not even an explicit nil

func (*ListMeta) UnsetNext

func (o *ListMeta) UnsetNext()

UnsetNext ensures that no value is present for Next, not even an explicit nil

func (*ListMeta) UnsetPrev

func (o *ListMeta) UnsetPrev()

UnsetPrev ensures that no value is present for Prev, not even an explicit nil

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 NullableError

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

func NewNullableError

func NewNullableError(val *Error) *NullableError

func (NullableError) Get

func (v NullableError) Get() *Error

func (NullableError) IsSet

func (v NullableError) IsSet() bool

func (NullableError) MarshalJSON

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

func (*NullableError) Set

func (v *NullableError) Set(val *Error)

func (*NullableError) UnmarshalJSON

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

func (*NullableError) Unset

func (v *NullableError) Unset()

type NullableErrorSource

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

func NewNullableErrorSource

func NewNullableErrorSource(val *ErrorSource) *NullableErrorSource

func (NullableErrorSource) Get

func (NullableErrorSource) IsSet

func (v NullableErrorSource) IsSet() bool

func (NullableErrorSource) MarshalJSON

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

func (*NullableErrorSource) Set

func (v *NullableErrorSource) Set(val *ErrorSource)

func (*NullableErrorSource) UnmarshalJSON

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

func (*NullableErrorSource) Unset

func (v *NullableErrorSource) Unset()

type NullableFailure

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

func NewNullableFailure

func NewNullableFailure(val *Failure) *NullableFailure

func (NullableFailure) Get

func (v NullableFailure) Get() *Failure

func (NullableFailure) IsSet

func (v NullableFailure) IsSet() bool

func (NullableFailure) MarshalJSON

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

func (*NullableFailure) Set

func (v *NullableFailure) Set(val *Failure)

func (*NullableFailure) UnmarshalJSON

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

func (*NullableFailure) Unset

func (v *NullableFailure) 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 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 NullableListMeta

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

func NewNullableListMeta

func NewNullableListMeta(val *ListMeta) *NullableListMeta

func (NullableListMeta) Get

func (v NullableListMeta) Get() *ListMeta

func (NullableListMeta) IsSet

func (v NullableListMeta) IsSet() bool

func (NullableListMeta) MarshalJSON

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

func (*NullableListMeta) Set

func (v *NullableListMeta) Set(val *ListMeta)

func (*NullableListMeta) UnmarshalJSON

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

func (*NullableListMeta) Unset

func (v *NullableListMeta) Unset()

type NullableObjectMeta

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

func NewNullableObjectMeta

func NewNullableObjectMeta(val *ObjectMeta) *NullableObjectMeta

func (NullableObjectMeta) Get

func (v NullableObjectMeta) Get() *ObjectMeta

func (NullableObjectMeta) IsSet

func (v NullableObjectMeta) IsSet() bool

func (NullableObjectMeta) MarshalJSON

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

func (*NullableObjectMeta) Set

func (v *NullableObjectMeta) Set(val *ObjectMeta)

func (*NullableObjectMeta) UnmarshalJSON

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

func (*NullableObjectMeta) Unset

func (v *NullableObjectMeta) Unset()

type NullableObjectReference

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

func NewNullableObjectReference

func NewNullableObjectReference(val *ObjectReference) *NullableObjectReference

func (NullableObjectReference) Get

func (NullableObjectReference) IsSet

func (v NullableObjectReference) IsSet() bool

func (NullableObjectReference) MarshalJSON

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

func (*NullableObjectReference) Set

func (*NullableObjectReference) UnmarshalJSON

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

func (*NullableObjectReference) Unset

func (v *NullableObjectReference) Unset()

type NullableQuotasV2AppliedQuota

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

func NewNullableQuotasV2AppliedQuota

func NewNullableQuotasV2AppliedQuota(val *QuotasV2AppliedQuota) *NullableQuotasV2AppliedQuota

func (NullableQuotasV2AppliedQuota) Get

func (NullableQuotasV2AppliedQuota) IsSet

func (NullableQuotasV2AppliedQuota) MarshalJSON

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

func (*NullableQuotasV2AppliedQuota) Set

func (*NullableQuotasV2AppliedQuota) UnmarshalJSON

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

func (*NullableQuotasV2AppliedQuota) Unset

func (v *NullableQuotasV2AppliedQuota) Unset()

type NullableQuotasV2AppliedQuotaList

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

func (NullableQuotasV2AppliedQuotaList) Get

func (NullableQuotasV2AppliedQuotaList) IsSet

func (NullableQuotasV2AppliedQuotaList) MarshalJSON

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

func (*NullableQuotasV2AppliedQuotaList) Set

func (*NullableQuotasV2AppliedQuotaList) UnmarshalJSON

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

func (*NullableQuotasV2AppliedQuotaList) Unset

type NullableQuotasV2Scope

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

func NewNullableQuotasV2Scope

func NewNullableQuotasV2Scope(val *QuotasV2Scope) *NullableQuotasV2Scope

func (NullableQuotasV2Scope) Get

func (NullableQuotasV2Scope) IsSet

func (v NullableQuotasV2Scope) IsSet() bool

func (NullableQuotasV2Scope) MarshalJSON

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

func (*NullableQuotasV2Scope) Set

func (v *NullableQuotasV2Scope) Set(val *QuotasV2Scope)

func (*NullableQuotasV2Scope) UnmarshalJSON

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

func (*NullableQuotasV2Scope) Unset

func (v *NullableQuotasV2Scope) Unset()

type NullableQuotasV2ScopeList

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

func NewNullableQuotasV2ScopeList

func NewNullableQuotasV2ScopeList(val *QuotasV2ScopeList) *NullableQuotasV2ScopeList

func (NullableQuotasV2ScopeList) Get

func (NullableQuotasV2ScopeList) IsSet

func (v NullableQuotasV2ScopeList) IsSet() bool

func (NullableQuotasV2ScopeList) MarshalJSON

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

func (*NullableQuotasV2ScopeList) Set

func (*NullableQuotasV2ScopeList) UnmarshalJSON

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

func (*NullableQuotasV2ScopeList) Unset

func (v *NullableQuotasV2ScopeList) 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 ObjectMeta

type ObjectMeta struct {
	// Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time
	Self string `json:"self"`
	// Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name
	ResourceName *string `json:"resource_name,omitempty"`
	// The date and time at which this object was created. It is represented in RFC3339 format and is in UTC.
	CreatedAt *time.Time `json:"created_at,omitempty"`
	// The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC.
	UpdatedAt *time.Time `json:"updated_at,omitempty"`
	// The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC.
	DeletedAt *time.Time `json:"deleted_at,omitempty"`
}

ObjectMeta ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

func NewObjectMeta

func NewObjectMeta(self string) *ObjectMeta

NewObjectMeta instantiates a new ObjectMeta 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 NewObjectMetaWithDefaults

func NewObjectMetaWithDefaults() *ObjectMeta

NewObjectMetaWithDefaults instantiates a new ObjectMeta 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 (*ObjectMeta) GetCreatedAt

func (o *ObjectMeta) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field value if set, zero value otherwise.

func (*ObjectMeta) GetCreatedAtOk

func (o *ObjectMeta) GetCreatedAtOk() (*time.Time, bool)

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

func (*ObjectMeta) GetDeletedAt

func (o *ObjectMeta) GetDeletedAt() time.Time

GetDeletedAt returns the DeletedAt field value if set, zero value otherwise.

func (*ObjectMeta) GetDeletedAtOk

func (o *ObjectMeta) GetDeletedAtOk() (*time.Time, bool)

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

func (*ObjectMeta) GetResourceName

func (o *ObjectMeta) GetResourceName() string

GetResourceName returns the ResourceName field value if set, zero value otherwise.

func (*ObjectMeta) GetResourceNameOk

func (o *ObjectMeta) GetResourceNameOk() (*string, bool)

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

func (*ObjectMeta) GetSelf

func (o *ObjectMeta) GetSelf() string

GetSelf returns the Self field value

func (*ObjectMeta) GetSelfOk

func (o *ObjectMeta) GetSelfOk() (*string, bool)

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

func (*ObjectMeta) GetUpdatedAt

func (o *ObjectMeta) GetUpdatedAt() time.Time

GetUpdatedAt returns the UpdatedAt field value if set, zero value otherwise.

func (*ObjectMeta) GetUpdatedAtOk

func (o *ObjectMeta) GetUpdatedAtOk() (*time.Time, bool)

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

func (*ObjectMeta) HasCreatedAt

func (o *ObjectMeta) HasCreatedAt() bool

HasCreatedAt returns a boolean if a field has been set.

func (*ObjectMeta) HasDeletedAt

func (o *ObjectMeta) HasDeletedAt() bool

HasDeletedAt returns a boolean if a field has been set.

func (*ObjectMeta) HasResourceName

func (o *ObjectMeta) HasResourceName() bool

HasResourceName returns a boolean if a field has been set.

func (*ObjectMeta) HasUpdatedAt

func (o *ObjectMeta) HasUpdatedAt() bool

HasUpdatedAt returns a boolean if a field has been set.

func (ObjectMeta) MarshalJSON

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

func (*ObjectMeta) Redact

func (o *ObjectMeta) Redact()

Redact resets all sensitive fields to their zero value.

func (*ObjectMeta) SetCreatedAt

func (o *ObjectMeta) SetCreatedAt(v time.Time)

SetCreatedAt gets a reference to the given time.Time and assigns it to the CreatedAt field.

func (*ObjectMeta) SetDeletedAt

func (o *ObjectMeta) SetDeletedAt(v time.Time)

SetDeletedAt gets a reference to the given time.Time and assigns it to the DeletedAt field.

func (*ObjectMeta) SetResourceName

func (o *ObjectMeta) SetResourceName(v string)

SetResourceName gets a reference to the given string and assigns it to the ResourceName field.

func (*ObjectMeta) SetSelf

func (o *ObjectMeta) SetSelf(v string)

SetSelf sets field value

func (*ObjectMeta) SetUpdatedAt

func (o *ObjectMeta) SetUpdatedAt(v time.Time)

SetUpdatedAt gets a reference to the given time.Time and assigns it to the UpdatedAt field.

type ObjectReference

type ObjectReference struct {
	// ID of the referred resource
	Id string `json:"id"`
	// Environment of the referred resource, if env-scoped
	Environment *string `json:"environment,omitempty"`
	// API URL for accessing or modifying the referred object
	Related string `json:"related"`
	// CRN reference to the referred resource
	ResourceName string `json:"resource_name"`
	// API group and version of the referred resource
	ApiVersion *string `json:"api_version,omitempty"`
	// Kind of the referred resource
	Kind *string `json:"kind,omitempty"`
}

ObjectReference ObjectReference provides information for you to locate the referred object

func NewObjectReference

func NewObjectReference(id string, related string, resourceName string) *ObjectReference

NewObjectReference instantiates a new ObjectReference 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 NewObjectReferenceWithDefaults

func NewObjectReferenceWithDefaults() *ObjectReference

NewObjectReferenceWithDefaults instantiates a new ObjectReference 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 (*ObjectReference) GetApiVersion

func (o *ObjectReference) GetApiVersion() string

GetApiVersion returns the ApiVersion field value if set, zero value otherwise.

func (*ObjectReference) GetApiVersionOk

func (o *ObjectReference) GetApiVersionOk() (*string, bool)

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

func (*ObjectReference) GetEnvironment

func (o *ObjectReference) GetEnvironment() string

GetEnvironment returns the Environment field value if set, zero value otherwise.

func (*ObjectReference) GetEnvironmentOk

func (o *ObjectReference) GetEnvironmentOk() (*string, bool)

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

func (*ObjectReference) GetId

func (o *ObjectReference) GetId() string

GetId returns the Id field value

func (*ObjectReference) GetIdOk

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

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

func (*ObjectReference) GetKind

func (o *ObjectReference) GetKind() string

GetKind returns the Kind field value if set, zero value otherwise.

func (*ObjectReference) GetKindOk

func (o *ObjectReference) GetKindOk() (*string, bool)

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

func (*ObjectReference) GetRelated

func (o *ObjectReference) GetRelated() string

GetRelated returns the Related field value

func (*ObjectReference) GetRelatedOk

func (o *ObjectReference) GetRelatedOk() (*string, bool)

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

func (*ObjectReference) GetResourceName

func (o *ObjectReference) GetResourceName() string

GetResourceName returns the ResourceName field value

func (*ObjectReference) GetResourceNameOk

func (o *ObjectReference) GetResourceNameOk() (*string, bool)

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

func (*ObjectReference) HasApiVersion

func (o *ObjectReference) HasApiVersion() bool

HasApiVersion returns a boolean if a field has been set.

func (*ObjectReference) HasEnvironment

func (o *ObjectReference) HasEnvironment() bool

HasEnvironment returns a boolean if a field has been set.

func (*ObjectReference) HasKind

func (o *ObjectReference) HasKind() bool

HasKind returns a boolean if a field has been set.

func (ObjectReference) MarshalJSON

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

func (*ObjectReference) Redact

func (o *ObjectReference) Redact()

Redact resets all sensitive fields to their zero value.

func (*ObjectReference) SetApiVersion

func (o *ObjectReference) SetApiVersion(v string)

SetApiVersion gets a reference to the given string and assigns it to the ApiVersion field.

func (*ObjectReference) SetEnvironment

func (o *ObjectReference) SetEnvironment(v string)

SetEnvironment gets a reference to the given string and assigns it to the Environment field.

func (*ObjectReference) SetId

func (o *ObjectReference) SetId(v string)

SetId sets field value

func (*ObjectReference) SetKind

func (o *ObjectReference) SetKind(v string)

SetKind gets a reference to the given string and assigns it to the Kind field.

func (*ObjectReference) SetRelated

func (o *ObjectReference) SetRelated(v string)

SetRelated sets field value

func (*ObjectReference) SetResourceName

func (o *ObjectReference) SetResourceName(v string)

SetResourceName sets field value

type QuotasV2AppliedQuota

type QuotasV2AppliedQuota struct {
	// APIVersion defines the schema version of this representation of a resource.
	ApiVersion *string `json:"api_version,omitempty"`
	// Kind defines the object this REST resource represents.
	Kind *string `json:"kind,omitempty"`
	// ID is the \"natural identifier\" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted (\"time\"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace (\"space\").
	Id       *string     `json:"id,omitempty"`
	Metadata *ObjectMeta `json:"metadata,omitempty"`
	// The applied scope that this quota belongs to.
	Scope *string `json:"scope,omitempty"`
	// A human-readable name for the quota type name.
	DisplayName *string `json:"display_name,omitempty"`
	// The default service quota value.
	DefaultLimit *int32 `json:"default_limit,omitempty"`
	// The latest applied service quota value, taking into account any limit adjustments.
	AppliedLimit *int32 `json:"applied_limit,omitempty"`
	// Show the quota usage value if the quota usage is available for this quota.
	Usage *int32 `json:"usage,omitempty"`
	// The user associated with this object.
	User *ObjectReference `json:"user,omitempty"`
	// A unique organization id to associate a specific organization to this quota. May be `null` if not associated with a organization.
	Organization *ObjectReference `json:"organization,omitempty"`
	// The environment ID the quota is associated with.  May be `null` if not associated with a environment.
	Environment *ObjectReference `json:"environment,omitempty"`
	// The network ID the quota is associated with.  May be `null` if not associated with a network.
	Network *ObjectReference `json:"network,omitempty"`
	// The kafka cluster ID the quota is associated with.  May be `null` if not associated with a kafka_cluster.
	KafkaCluster *ObjectReference `json:"kafka_cluster,omitempty"`
}

QuotasV2AppliedQuota A `quota` object represents a quota configuration for a specific Confluent Cloud resource. Use this API to retrieve an individual quota or list of quotas for a given scope. Related guide: [Service Quotas for Confluent Cloud](https://docs.confluent.io/cloud/current/quotas/index.html). ## The Applied Quotas Model <SchemaDefinition schemaRef=\"#/components/schemas/quotas.v2.AppliedQuota\" />

func NewQuotasV2AppliedQuota

func NewQuotasV2AppliedQuota() *QuotasV2AppliedQuota

NewQuotasV2AppliedQuota instantiates a new QuotasV2AppliedQuota 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 NewQuotasV2AppliedQuotaWithDefaults

func NewQuotasV2AppliedQuotaWithDefaults() *QuotasV2AppliedQuota

NewQuotasV2AppliedQuotaWithDefaults instantiates a new QuotasV2AppliedQuota 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 (*QuotasV2AppliedQuota) GetApiVersion

func (o *QuotasV2AppliedQuota) GetApiVersion() string

GetApiVersion returns the ApiVersion field value if set, zero value otherwise.

func (*QuotasV2AppliedQuota) GetApiVersionOk

func (o *QuotasV2AppliedQuota) GetApiVersionOk() (*string, bool)

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

func (*QuotasV2AppliedQuota) GetAppliedLimit

func (o *QuotasV2AppliedQuota) GetAppliedLimit() int32

GetAppliedLimit returns the AppliedLimit field value if set, zero value otherwise.

func (*QuotasV2AppliedQuota) GetAppliedLimitOk

func (o *QuotasV2AppliedQuota) GetAppliedLimitOk() (*int32, bool)

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

func (*QuotasV2AppliedQuota) GetDefaultLimit

func (o *QuotasV2AppliedQuota) GetDefaultLimit() int32

GetDefaultLimit returns the DefaultLimit field value if set, zero value otherwise.

func (*QuotasV2AppliedQuota) GetDefaultLimitOk

func (o *QuotasV2AppliedQuota) GetDefaultLimitOk() (*int32, bool)

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

func (*QuotasV2AppliedQuota) GetDisplayName

func (o *QuotasV2AppliedQuota) GetDisplayName() string

GetDisplayName returns the DisplayName field value if set, zero value otherwise.

func (*QuotasV2AppliedQuota) GetDisplayNameOk

func (o *QuotasV2AppliedQuota) GetDisplayNameOk() (*string, bool)

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

func (*QuotasV2AppliedQuota) GetEnvironment

func (o *QuotasV2AppliedQuota) GetEnvironment() ObjectReference

GetEnvironment returns the Environment field value if set, zero value otherwise.

func (*QuotasV2AppliedQuota) GetEnvironmentOk

func (o *QuotasV2AppliedQuota) GetEnvironmentOk() (*ObjectReference, bool)

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

func (*QuotasV2AppliedQuota) GetId

func (o *QuotasV2AppliedQuota) GetId() string

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

func (*QuotasV2AppliedQuota) GetIdOk

func (o *QuotasV2AppliedQuota) 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 (*QuotasV2AppliedQuota) GetKafkaCluster

func (o *QuotasV2AppliedQuota) GetKafkaCluster() ObjectReference

GetKafkaCluster returns the KafkaCluster field value if set, zero value otherwise.

func (*QuotasV2AppliedQuota) GetKafkaClusterOk

func (o *QuotasV2AppliedQuota) GetKafkaClusterOk() (*ObjectReference, bool)

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

func (*QuotasV2AppliedQuota) GetKind

func (o *QuotasV2AppliedQuota) GetKind() string

GetKind returns the Kind field value if set, zero value otherwise.

func (*QuotasV2AppliedQuota) GetKindOk

func (o *QuotasV2AppliedQuota) GetKindOk() (*string, bool)

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

func (*QuotasV2AppliedQuota) GetMetadata

func (o *QuotasV2AppliedQuota) GetMetadata() ObjectMeta

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*QuotasV2AppliedQuota) GetMetadataOk

func (o *QuotasV2AppliedQuota) GetMetadataOk() (*ObjectMeta, bool)

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

func (*QuotasV2AppliedQuota) GetNetwork

func (o *QuotasV2AppliedQuota) GetNetwork() ObjectReference

GetNetwork returns the Network field value if set, zero value otherwise.

func (*QuotasV2AppliedQuota) GetNetworkOk

func (o *QuotasV2AppliedQuota) GetNetworkOk() (*ObjectReference, bool)

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

func (*QuotasV2AppliedQuota) GetOrganization

func (o *QuotasV2AppliedQuota) GetOrganization() ObjectReference

GetOrganization returns the Organization field value if set, zero value otherwise.

func (*QuotasV2AppliedQuota) GetOrganizationOk

func (o *QuotasV2AppliedQuota) GetOrganizationOk() (*ObjectReference, bool)

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

func (*QuotasV2AppliedQuota) GetScope

func (o *QuotasV2AppliedQuota) GetScope() string

GetScope returns the Scope field value if set, zero value otherwise.

func (*QuotasV2AppliedQuota) GetScopeOk

func (o *QuotasV2AppliedQuota) GetScopeOk() (*string, bool)

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

func (*QuotasV2AppliedQuota) GetUsage

func (o *QuotasV2AppliedQuota) GetUsage() int32

GetUsage returns the Usage field value if set, zero value otherwise.

func (*QuotasV2AppliedQuota) GetUsageOk

func (o *QuotasV2AppliedQuota) GetUsageOk() (*int32, bool)

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

func (*QuotasV2AppliedQuota) GetUser

GetUser returns the User field value if set, zero value otherwise.

func (*QuotasV2AppliedQuota) GetUserOk

func (o *QuotasV2AppliedQuota) GetUserOk() (*ObjectReference, bool)

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

func (*QuotasV2AppliedQuota) HasApiVersion

func (o *QuotasV2AppliedQuota) HasApiVersion() bool

HasApiVersion returns a boolean if a field has been set.

func (*QuotasV2AppliedQuota) HasAppliedLimit

func (o *QuotasV2AppliedQuota) HasAppliedLimit() bool

HasAppliedLimit returns a boolean if a field has been set.

func (*QuotasV2AppliedQuota) HasDefaultLimit

func (o *QuotasV2AppliedQuota) HasDefaultLimit() bool

HasDefaultLimit returns a boolean if a field has been set.

func (*QuotasV2AppliedQuota) HasDisplayName

func (o *QuotasV2AppliedQuota) HasDisplayName() bool

HasDisplayName returns a boolean if a field has been set.

func (*QuotasV2AppliedQuota) HasEnvironment

func (o *QuotasV2AppliedQuota) HasEnvironment() bool

HasEnvironment returns a boolean if a field has been set.

func (*QuotasV2AppliedQuota) HasId

func (o *QuotasV2AppliedQuota) HasId() bool

HasId returns a boolean if a field has been set.

func (*QuotasV2AppliedQuota) HasKafkaCluster

func (o *QuotasV2AppliedQuota) HasKafkaCluster() bool

HasKafkaCluster returns a boolean if a field has been set.

func (*QuotasV2AppliedQuota) HasKind

func (o *QuotasV2AppliedQuota) HasKind() bool

HasKind returns a boolean if a field has been set.

func (*QuotasV2AppliedQuota) HasMetadata

func (o *QuotasV2AppliedQuota) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*QuotasV2AppliedQuota) HasNetwork

func (o *QuotasV2AppliedQuota) HasNetwork() bool

HasNetwork returns a boolean if a field has been set.

func (*QuotasV2AppliedQuota) HasOrganization

func (o *QuotasV2AppliedQuota) HasOrganization() bool

HasOrganization returns a boolean if a field has been set.

func (*QuotasV2AppliedQuota) HasScope

func (o *QuotasV2AppliedQuota) HasScope() bool

HasScope returns a boolean if a field has been set.

func (*QuotasV2AppliedQuota) HasUsage

func (o *QuotasV2AppliedQuota) HasUsage() bool

HasUsage returns a boolean if a field has been set.

func (*QuotasV2AppliedQuota) HasUser

func (o *QuotasV2AppliedQuota) HasUser() bool

HasUser returns a boolean if a field has been set.

func (QuotasV2AppliedQuota) MarshalJSON

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

func (*QuotasV2AppliedQuota) Redact

func (o *QuotasV2AppliedQuota) Redact()

Redact resets all sensitive fields to their zero value.

func (*QuotasV2AppliedQuota) SetApiVersion

func (o *QuotasV2AppliedQuota) SetApiVersion(v string)

SetApiVersion gets a reference to the given string and assigns it to the ApiVersion field.

func (*QuotasV2AppliedQuota) SetAppliedLimit

func (o *QuotasV2AppliedQuota) SetAppliedLimit(v int32)

SetAppliedLimit gets a reference to the given int32 and assigns it to the AppliedLimit field.

func (*QuotasV2AppliedQuota) SetDefaultLimit

func (o *QuotasV2AppliedQuota) SetDefaultLimit(v int32)

SetDefaultLimit gets a reference to the given int32 and assigns it to the DefaultLimit field.

func (*QuotasV2AppliedQuota) SetDisplayName

func (o *QuotasV2AppliedQuota) SetDisplayName(v string)

SetDisplayName gets a reference to the given string and assigns it to the DisplayName field.

func (*QuotasV2AppliedQuota) SetEnvironment

func (o *QuotasV2AppliedQuota) SetEnvironment(v ObjectReference)

SetEnvironment gets a reference to the given ObjectReference and assigns it to the Environment field.

func (*QuotasV2AppliedQuota) SetId

func (o *QuotasV2AppliedQuota) SetId(v string)

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

func (*QuotasV2AppliedQuota) SetKafkaCluster

func (o *QuotasV2AppliedQuota) SetKafkaCluster(v ObjectReference)

SetKafkaCluster gets a reference to the given ObjectReference and assigns it to the KafkaCluster field.

func (*QuotasV2AppliedQuota) SetKind

func (o *QuotasV2AppliedQuota) SetKind(v string)

SetKind gets a reference to the given string and assigns it to the Kind field.

func (*QuotasV2AppliedQuota) SetMetadata

func (o *QuotasV2AppliedQuota) SetMetadata(v ObjectMeta)

SetMetadata gets a reference to the given ObjectMeta and assigns it to the Metadata field.

func (*QuotasV2AppliedQuota) SetNetwork

func (o *QuotasV2AppliedQuota) SetNetwork(v ObjectReference)

SetNetwork gets a reference to the given ObjectReference and assigns it to the Network field.

func (*QuotasV2AppliedQuota) SetOrganization

func (o *QuotasV2AppliedQuota) SetOrganization(v ObjectReference)

SetOrganization gets a reference to the given ObjectReference and assigns it to the Organization field.

func (*QuotasV2AppliedQuota) SetScope

func (o *QuotasV2AppliedQuota) SetScope(v string)

SetScope gets a reference to the given string and assigns it to the Scope field.

func (*QuotasV2AppliedQuota) SetUsage

func (o *QuotasV2AppliedQuota) SetUsage(v int32)

SetUsage gets a reference to the given int32 and assigns it to the Usage field.

func (*QuotasV2AppliedQuota) SetUser

func (o *QuotasV2AppliedQuota) SetUser(v ObjectReference)

SetUser gets a reference to the given ObjectReference and assigns it to the User field.

type QuotasV2AppliedQuotaList

type QuotasV2AppliedQuotaList struct {
	// APIVersion defines the schema version of this representation of a resource.
	ApiVersion string `json:"api_version"`
	// Kind defines the object this REST resource represents.
	Kind     string   `json:"kind"`
	Metadata ListMeta `json:"metadata"`
	// A data property that contains an array of resource items. Each entry in the array is a separate resource.
	Data []QuotasV2AppliedQuota `json:"data"`
}

QuotasV2AppliedQuotaList A `quota` object represents a quota configuration for a specific Confluent Cloud resource. Use this API to retrieve an individual quota or list of quotas for a given scope. Related guide: [Service Quotas for Confluent Cloud](https://docs.confluent.io/cloud/current/quotas/index.html). ## The Applied Quotas Model <SchemaDefinition schemaRef=\"#/components/schemas/quotas.v2.AppliedQuota\" />

func NewQuotasV2AppliedQuotaList

func NewQuotasV2AppliedQuotaList(apiVersion string, kind string, metadata ListMeta, data []QuotasV2AppliedQuota) *QuotasV2AppliedQuotaList

NewQuotasV2AppliedQuotaList instantiates a new QuotasV2AppliedQuotaList 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 NewQuotasV2AppliedQuotaListWithDefaults

func NewQuotasV2AppliedQuotaListWithDefaults() *QuotasV2AppliedQuotaList

NewQuotasV2AppliedQuotaListWithDefaults instantiates a new QuotasV2AppliedQuotaList 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 (*QuotasV2AppliedQuotaList) GetApiVersion

func (o *QuotasV2AppliedQuotaList) GetApiVersion() string

GetApiVersion returns the ApiVersion field value

func (*QuotasV2AppliedQuotaList) GetApiVersionOk

func (o *QuotasV2AppliedQuotaList) GetApiVersionOk() (*string, bool)

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

func (*QuotasV2AppliedQuotaList) GetData

GetData returns the Data field value

func (*QuotasV2AppliedQuotaList) GetDataOk

func (o *QuotasV2AppliedQuotaList) GetDataOk() (*[]QuotasV2AppliedQuota, bool)

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

func (*QuotasV2AppliedQuotaList) GetKind

func (o *QuotasV2AppliedQuotaList) GetKind() string

GetKind returns the Kind field value

func (*QuotasV2AppliedQuotaList) GetKindOk

func (o *QuotasV2AppliedQuotaList) GetKindOk() (*string, bool)

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

func (*QuotasV2AppliedQuotaList) GetMetadata

func (o *QuotasV2AppliedQuotaList) GetMetadata() ListMeta

GetMetadata returns the Metadata field value

func (*QuotasV2AppliedQuotaList) GetMetadataOk

func (o *QuotasV2AppliedQuotaList) GetMetadataOk() (*ListMeta, bool)

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

func (QuotasV2AppliedQuotaList) MarshalJSON

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

func (*QuotasV2AppliedQuotaList) Redact

func (o *QuotasV2AppliedQuotaList) Redact()

Redact resets all sensitive fields to their zero value.

func (*QuotasV2AppliedQuotaList) SetApiVersion

func (o *QuotasV2AppliedQuotaList) SetApiVersion(v string)

SetApiVersion sets field value

func (*QuotasV2AppliedQuotaList) SetData

SetData sets field value

func (*QuotasV2AppliedQuotaList) SetKind

func (o *QuotasV2AppliedQuotaList) SetKind(v string)

SetKind sets field value

func (*QuotasV2AppliedQuotaList) SetMetadata

func (o *QuotasV2AppliedQuotaList) SetMetadata(v ListMeta)

SetMetadata sets field value

type QuotasV2Scope

type QuotasV2Scope struct {
	// APIVersion defines the schema version of this representation of a resource.
	ApiVersion *string `json:"api_version,omitempty"`
	// Kind defines the object this REST resource represents.
	Kind *string `json:"kind,omitempty"`
	// ID is the \"natural identifier\" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted (\"time\"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace (\"space\").
	Id       *string     `json:"id,omitempty"`
	Metadata *ObjectMeta `json:"metadata,omitempty"`
	// the quota scope for listing quotas queries
	Description *string `json:"description,omitempty"`
}

QuotasV2Scope Gets a list of all available scopes for applied quotas. Related guide: [Quota Scopes](https://docs.confluent.io/cloud/current/quotas/quotas.html#query-for-scopes). ## The Scopes Model <SchemaDefinition schemaRef=\"#/components/schemas/quotas.v2.Scope\" />

func NewQuotasV2Scope

func NewQuotasV2Scope() *QuotasV2Scope

NewQuotasV2Scope instantiates a new QuotasV2Scope 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 NewQuotasV2ScopeWithDefaults

func NewQuotasV2ScopeWithDefaults() *QuotasV2Scope

NewQuotasV2ScopeWithDefaults instantiates a new QuotasV2Scope 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 (*QuotasV2Scope) GetApiVersion

func (o *QuotasV2Scope) GetApiVersion() string

GetApiVersion returns the ApiVersion field value if set, zero value otherwise.

func (*QuotasV2Scope) GetApiVersionOk

func (o *QuotasV2Scope) GetApiVersionOk() (*string, bool)

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

func (*QuotasV2Scope) GetDescription

func (o *QuotasV2Scope) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise.

func (*QuotasV2Scope) GetDescriptionOk

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

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

func (*QuotasV2Scope) GetId

func (o *QuotasV2Scope) GetId() string

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

func (*QuotasV2Scope) GetIdOk

func (o *QuotasV2Scope) 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 (*QuotasV2Scope) GetKind

func (o *QuotasV2Scope) GetKind() string

GetKind returns the Kind field value if set, zero value otherwise.

func (*QuotasV2Scope) GetKindOk

func (o *QuotasV2Scope) GetKindOk() (*string, bool)

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

func (*QuotasV2Scope) GetMetadata

func (o *QuotasV2Scope) GetMetadata() ObjectMeta

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*QuotasV2Scope) GetMetadataOk

func (o *QuotasV2Scope) GetMetadataOk() (*ObjectMeta, bool)

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

func (*QuotasV2Scope) HasApiVersion

func (o *QuotasV2Scope) HasApiVersion() bool

HasApiVersion returns a boolean if a field has been set.

func (*QuotasV2Scope) HasDescription

func (o *QuotasV2Scope) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*QuotasV2Scope) HasId

func (o *QuotasV2Scope) HasId() bool

HasId returns a boolean if a field has been set.

func (*QuotasV2Scope) HasKind

func (o *QuotasV2Scope) HasKind() bool

HasKind returns a boolean if a field has been set.

func (*QuotasV2Scope) HasMetadata

func (o *QuotasV2Scope) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (QuotasV2Scope) MarshalJSON

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

func (*QuotasV2Scope) Redact

func (o *QuotasV2Scope) Redact()

Redact resets all sensitive fields to their zero value.

func (*QuotasV2Scope) SetApiVersion

func (o *QuotasV2Scope) SetApiVersion(v string)

SetApiVersion gets a reference to the given string and assigns it to the ApiVersion field.

func (*QuotasV2Scope) SetDescription

func (o *QuotasV2Scope) SetDescription(v string)

SetDescription gets a reference to the given string and assigns it to the Description field.

func (*QuotasV2Scope) SetId

func (o *QuotasV2Scope) SetId(v string)

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

func (*QuotasV2Scope) SetKind

func (o *QuotasV2Scope) SetKind(v string)

SetKind gets a reference to the given string and assigns it to the Kind field.

func (*QuotasV2Scope) SetMetadata

func (o *QuotasV2Scope) SetMetadata(v ObjectMeta)

SetMetadata gets a reference to the given ObjectMeta and assigns it to the Metadata field.

type QuotasV2ScopeList

type QuotasV2ScopeList struct {
	// APIVersion defines the schema version of this representation of a resource.
	ApiVersion string `json:"api_version"`
	// Kind defines the object this REST resource represents.
	Kind     string   `json:"kind"`
	Metadata ListMeta `json:"metadata"`
	// A data property that contains an array of resource items. Each entry in the array is a separate resource.
	Data []QuotasV2Scope `json:"data"`
}

QuotasV2ScopeList Gets a list of all available scopes for applied quotas. Related guide: [Quota Scopes](https://docs.confluent.io/cloud/current/quotas/quotas.html#query-for-scopes). ## The Scopes Model <SchemaDefinition schemaRef=\"#/components/schemas/quotas.v2.Scope\" />

func NewQuotasV2ScopeList

func NewQuotasV2ScopeList(apiVersion string, kind string, metadata ListMeta, data []QuotasV2Scope) *QuotasV2ScopeList

NewQuotasV2ScopeList instantiates a new QuotasV2ScopeList 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 NewQuotasV2ScopeListWithDefaults

func NewQuotasV2ScopeListWithDefaults() *QuotasV2ScopeList

NewQuotasV2ScopeListWithDefaults instantiates a new QuotasV2ScopeList 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 (*QuotasV2ScopeList) GetApiVersion

func (o *QuotasV2ScopeList) GetApiVersion() string

GetApiVersion returns the ApiVersion field value

func (*QuotasV2ScopeList) GetApiVersionOk

func (o *QuotasV2ScopeList) GetApiVersionOk() (*string, bool)

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

func (*QuotasV2ScopeList) GetData

func (o *QuotasV2ScopeList) GetData() []QuotasV2Scope

GetData returns the Data field value

func (*QuotasV2ScopeList) GetDataOk

func (o *QuotasV2ScopeList) GetDataOk() (*[]QuotasV2Scope, bool)

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

func (*QuotasV2ScopeList) GetKind

func (o *QuotasV2ScopeList) GetKind() string

GetKind returns the Kind field value

func (*QuotasV2ScopeList) GetKindOk

func (o *QuotasV2ScopeList) GetKindOk() (*string, bool)

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

func (*QuotasV2ScopeList) GetMetadata

func (o *QuotasV2ScopeList) GetMetadata() ListMeta

GetMetadata returns the Metadata field value

func (*QuotasV2ScopeList) GetMetadataOk

func (o *QuotasV2ScopeList) GetMetadataOk() (*ListMeta, bool)

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

func (QuotasV2ScopeList) MarshalJSON

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

func (*QuotasV2ScopeList) Redact

func (o *QuotasV2ScopeList) Redact()

Redact resets all sensitive fields to their zero value.

func (*QuotasV2ScopeList) SetApiVersion

func (o *QuotasV2ScopeList) SetApiVersion(v string)

SetApiVersion sets field value

func (*QuotasV2ScopeList) SetData

func (o *QuotasV2ScopeList) SetData(v []QuotasV2Scope)

SetData sets field value

func (*QuotasV2ScopeList) SetKind

func (o *QuotasV2ScopeList) SetKind(v string)

SetKind sets field value

func (*QuotasV2ScopeList) SetMetadata

func (o *QuotasV2ScopeList) SetMetadata(v ListMeta)

SetMetadata sets field value

type ScopesQuotasV2Api

type ScopesQuotasV2Api interface {

	/*
		GetQuotasV2Scope Read a Scope

		[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Quotas v2](https://img.shields.io/badge/-Request%20Access%20To%20Quotas%20v2-%23bc8540)](mailto:ccloud-api-access+quotas-v2-early-access@confluent.io?subject=Request%20to%20join%20quotas/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20quotas/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

	Make a request to read a scope.

		 @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 @param id The unique identifier for the scope.
		 @return ApiGetQuotasV2ScopeRequest
	*/
	GetQuotasV2Scope(ctx _context.Context, id string) ApiGetQuotasV2ScopeRequest

	// GetQuotasV2ScopeExecute executes the request
	//  @return QuotasV2Scope
	GetQuotasV2ScopeExecute(r ApiGetQuotasV2ScopeRequest) (QuotasV2Scope, *_nethttp.Response, error)

	/*
		ListQuotasV2Scopes List of Scopes

		[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Quotas v2](https://img.shields.io/badge/-Request%20Access%20To%20Quotas%20v2-%23bc8540)](mailto:ccloud-api-access+quotas-v2-early-access@confluent.io?subject=Request%20to%20join%20quotas/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20quotas/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

	Retrieve a sorted, filtered, paginated list of all scopes.

		 @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 @return ApiListQuotasV2ScopesRequest
	*/
	ListQuotasV2Scopes(ctx _context.Context) ApiListQuotasV2ScopesRequest

	// ListQuotasV2ScopesExecute executes the request
	//  @return QuotasV2ScopeList
	ListQuotasV2ScopesExecute(r ApiListQuotasV2ScopesRequest) (QuotasV2ScopeList, *_nethttp.Response, error)
}

type ScopesQuotasV2ApiService

type ScopesQuotasV2ApiService service

ScopesQuotasV2ApiService ScopesQuotasV2Api service

func (*ScopesQuotasV2ApiService) GetQuotasV2Scope

GetQuotasV2Scope Read a Scope

[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Quotas v2](https://img.shields.io/badge/-Request%20Access%20To%20Quotas%20v2-%23bc8540)](mailto:ccloud-api-access+quotas-v2-early-access@confluent.io?subject=Request%20to%20join%20quotas/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20quotas/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

Make a request to read a scope.

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The unique identifier for the scope.
@return ApiGetQuotasV2ScopeRequest

func (*ScopesQuotasV2ApiService) GetQuotasV2ScopeExecute

Execute executes the request

@return QuotasV2Scope

func (*ScopesQuotasV2ApiService) ListQuotasV2Scopes

ListQuotasV2Scopes List of Scopes

[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To Quotas v2](https://img.shields.io/badge/-Request%20Access%20To%20Quotas%20v2-%23bc8540)](mailto:ccloud-api-access+quotas-v2-early-access@confluent.io?subject=Request%20to%20join%20quotas/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20quotas/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)

Retrieve a sorted, filtered, paginated list of all scopes.

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiListQuotasV2ScopesRequest

func (*ScopesQuotasV2ApiService) ListQuotasV2ScopesExecute

Execute executes the request

@return QuotasV2ScopeList

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

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL