v3

package
v0.0.1 Latest Latest
Warning

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

 Go to latest Published: Oct 1, 2024 License: Apache-2.0 Imports: 22 Imported by: 2

README

Go API client for v3

Cluster Management Access for Schema Registry API

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 "./v3"

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
AccessesSrcmV3Api GetSrcmV3Access Get /srcm/v3/clusters/{id}/access Read an Access

Documentation For Models

Documentation For Authorization

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

data-governance@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 {
	AccessesSrcmV3Api AccessesSrcmV3Api
	// contains filtered or unexported fields
}

APIClient manages communication with the Cluster Management Access for Schema Registry API API v0.0.1-alpha1 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 AccessesSrcmV3Api 

type AccessesSrcmV3Api interface {

	/*
		GetSrcmV3Access Read an Access

		[![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)

	Make a request to read an access.

		 @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 access.
		 @return ApiGetSrcmV3AccessRequest
	*/
	GetSrcmV3Access(ctx _context.Context, id string) ApiGetSrcmV3AccessRequest

	// GetSrcmV3AccessExecute executes the request
	//  @return SrcmV3Access
	GetSrcmV3AccessExecute(r ApiGetSrcmV3AccessRequest) (SrcmV3Access, *_nethttp.Response, error)
}

type AccessesSrcmV3ApiService 

type AccessesSrcmV3ApiService service

AccessesSrcmV3ApiService AccessesSrcmV3Api service

func (*AccessesSrcmV3ApiService) GetSrcmV3Access 

func (a *AccessesSrcmV3ApiService) GetSrcmV3Access(ctx _context.Context, id string) ApiGetSrcmV3AccessRequest

GetSrcmV3Access Read an Access

[![Limited Availability](https://img.shields.io/badge/Lifecycle%20Stage-Limited%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)

Make a request to read an access. 

@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 access.
@return ApiGetSrcmV3AccessRequest

func (*AccessesSrcmV3ApiService) GetSrcmV3AccessExecute 

func (a *AccessesSrcmV3ApiService) GetSrcmV3AccessExecute(r ApiGetSrcmV3AccessRequest) (SrcmV3Access, *_nethttp.Response, error)

Execute executes the request 

@return SrcmV3Access

type ApiGetSrcmV3AccessRequest 

type ApiGetSrcmV3AccessRequest struct {
	ApiService AccessesSrcmV3Api
	// contains filtered or unexported fields
}

func (ApiGetSrcmV3AccessRequest) ClusterId 

func (r ApiGetSrcmV3AccessRequest) ClusterId(clusterId string) ApiGetSrcmV3AccessRequest

Logical cluster that will access schema registry.

func (ApiGetSrcmV3AccessRequest) Environment 

func (r ApiGetSrcmV3AccessRequest) Environment(environment string) ApiGetSrcmV3AccessRequest

Filter the results by exact match for environment.

func (ApiGetSrcmV3AccessRequest) Execute 

func (r ApiGetSrcmV3AccessRequest) Execute() (SrcmV3Access, *_nethttp.Response, error)

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,omitempty"`
}

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 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 (v NullableErrorSource) Get() *ErrorSource

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

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

func NewNullableSrcmV3Access 

func NewNullableSrcmV3Access(val *SrcmV3Access) *NullableSrcmV3Access

func (NullableSrcmV3Access) Get 

func (v NullableSrcmV3Access) Get() *SrcmV3Access

func (NullableSrcmV3Access) IsSet 

func (v NullableSrcmV3Access) IsSet() bool

func (NullableSrcmV3Access) MarshalJSON 

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

func (*NullableSrcmV3Access) Set 

func (v *NullableSrcmV3Access) Set(val *SrcmV3Access)

func (*NullableSrcmV3Access) UnmarshalJSON 

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

func (*NullableSrcmV3Access) Unset 

func (v *NullableSrcmV3Access) Unset()

type NullableSrcmV3AccessSpec 

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

func NewNullableSrcmV3AccessSpec 

func NewNullableSrcmV3AccessSpec(val *SrcmV3AccessSpec) *NullableSrcmV3AccessSpec

func (NullableSrcmV3AccessSpec) Get 

func (v NullableSrcmV3AccessSpec) Get() *SrcmV3AccessSpec

func (NullableSrcmV3AccessSpec) IsSet 

func (v NullableSrcmV3AccessSpec) IsSet() bool

func (NullableSrcmV3AccessSpec) MarshalJSON 

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

func (*NullableSrcmV3AccessSpec) Set 

func (v *NullableSrcmV3AccessSpec) Set(val *SrcmV3AccessSpec)

func (*NullableSrcmV3AccessSpec) UnmarshalJSON 

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

func (*NullableSrcmV3AccessSpec) Unset 

func (v *NullableSrcmV3AccessSpec) 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,omitempty"`
	// 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 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 SrcmV3Access 

type SrcmV3Access 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"`
	Spec     *SrcmV3AccessSpec `json:"spec,omitempty"`
}

SrcmV3Access `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. The API allows you to read your Schema Registry clusters access. Related guide: [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). ## The Accesses Model <SchemaDefinition schemaRef=\"#/components/schemas/srcm.v3.Access\" />

func NewSrcmV3Access 

func NewSrcmV3Access() *SrcmV3Access

NewSrcmV3Access instantiates a new SrcmV3Access 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 NewSrcmV3AccessWithDefaults 

func NewSrcmV3AccessWithDefaults() *SrcmV3Access

NewSrcmV3AccessWithDefaults instantiates a new SrcmV3Access 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 (*SrcmV3Access) GetApiVersion 

func (o *SrcmV3Access) GetApiVersion() string

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

func (*SrcmV3Access) GetApiVersionOk 

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

func (o *SrcmV3Access) GetId() string

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

func (*SrcmV3Access) GetIdOk 

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

func (o *SrcmV3Access) GetKind() string

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

func (*SrcmV3Access) GetKindOk 

func (o *SrcmV3Access) 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 (*SrcmV3Access) GetMetadata 

func (o *SrcmV3Access) GetMetadata() ObjectMeta

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

func (*SrcmV3Access) GetMetadataOk 

func (o *SrcmV3Access) 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 (*SrcmV3Access) GetSpec 

func (o *SrcmV3Access) GetSpec() SrcmV3AccessSpec

GetSpec returns the Spec field value if set, zero value otherwise.

func (*SrcmV3Access) GetSpecOk 

func (o *SrcmV3Access) GetSpecOk() (*SrcmV3AccessSpec, bool)

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

func (*SrcmV3Access) HasApiVersion 

func (o *SrcmV3Access) HasApiVersion() bool

HasApiVersion returns a boolean if a field has been set.

func (*SrcmV3Access) HasId 

func (o *SrcmV3Access) HasId() bool

HasId returns a boolean if a field has been set.

func (*SrcmV3Access) HasKind 

func (o *SrcmV3Access) HasKind() bool

HasKind returns a boolean if a field has been set.

func (*SrcmV3Access) HasMetadata 

func (o *SrcmV3Access) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*SrcmV3Access) HasSpec 

func (o *SrcmV3Access) HasSpec() bool

HasSpec returns a boolean if a field has been set.

func (SrcmV3Access) MarshalJSON 

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

func (*SrcmV3Access) Redact 

func (o *SrcmV3Access) Redact()

Redact resets all sensitive fields to their zero value.

func (*SrcmV3Access) SetApiVersion 

func (o *SrcmV3Access) SetApiVersion(v string)

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

func (*SrcmV3Access) SetId 

func (o *SrcmV3Access) SetId(v string)

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

func (*SrcmV3Access) SetKind 

func (o *SrcmV3Access) SetKind(v string)

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

func (*SrcmV3Access) SetMetadata 

func (o *SrcmV3Access) SetMetadata(v ObjectMeta)

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

func (*SrcmV3Access) SetSpec 

func (o *SrcmV3Access) SetSpec(v SrcmV3AccessSpec)

SetSpec gets a reference to the given SrcmV3AccessSpec and assigns it to the Spec field.

type SrcmV3AccessSpec 

type SrcmV3AccessSpec struct {
	// Alowed
	Allowed *bool `json:"allowed,omitempty"`
}

SrcmV3AccessSpec The desired state of the Access

func NewSrcmV3AccessSpec 

func NewSrcmV3AccessSpec() *SrcmV3AccessSpec

NewSrcmV3AccessSpec instantiates a new SrcmV3AccessSpec 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 NewSrcmV3AccessSpecWithDefaults 

func NewSrcmV3AccessSpecWithDefaults() *SrcmV3AccessSpec

NewSrcmV3AccessSpecWithDefaults instantiates a new SrcmV3AccessSpec 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 (*SrcmV3AccessSpec) GetAllowed 

func (o *SrcmV3AccessSpec) GetAllowed() bool

GetAllowed returns the Allowed field value if set, zero value otherwise.

func (*SrcmV3AccessSpec) GetAllowedOk 

func (o *SrcmV3AccessSpec) GetAllowedOk() (*bool, bool)

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

func (*SrcmV3AccessSpec) HasAllowed 

func (o *SrcmV3AccessSpec) HasAllowed() bool

HasAllowed returns a boolean if a field has been set.

func (SrcmV3AccessSpec) MarshalJSON 

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

func (*SrcmV3AccessSpec) Redact 

func (o *SrcmV3AccessSpec) Redact()

Redact resets all sensitive fields to their zero value.

func (*SrcmV3AccessSpec) SetAllowed 

func (o *SrcmV3AccessSpec) SetAllowed(v bool)

SetAllowed gets a reference to the given bool and assigns it to the Allowed field.

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.