v1

package
v0.0.2 Latest Latest
Warning

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

 Go to latest Published: Nov 29, 2023 License: Apache-2.0 Imports: 22 Imported by: 2

README

Go API client for v1

Upload and retrieve self-managed keys on dedicated Confluent Cloud clusters.

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

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
KeysByokV1Api CreateByokV1Key Post /byok/v1/keys Create a Key
KeysByokV1Api DeleteByokV1Key Delete /byok/v1/keys/{id} Delete a Key
KeysByokV1Api GetByokV1Key Get /byok/v1/keys/{id} Read a Key
KeysByokV1Api ListByokV1Keys Get /byok/v1/keys List of Keys

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

cire-storage@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 {
	KeysByokV1Api KeysByokV1Api
	// contains filtered or unexported fields
}

APIClient manages communication with the Key Management API for BYOK API v0.0.1 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 ApiCreateByokV1KeyRequest 

type ApiCreateByokV1KeyRequest struct {
	ApiService KeysByokV1Api
	// contains filtered or unexported fields
}

func (ApiCreateByokV1KeyRequest) ByokV1Key 

func (r ApiCreateByokV1KeyRequest) ByokV1Key(byokV1Key ByokV1Key) ApiCreateByokV1KeyRequest

func (ApiCreateByokV1KeyRequest) Execute 

func (r ApiCreateByokV1KeyRequest) Execute() (ByokV1Key, *_nethttp.Response, error)

type ApiDeleteByokV1KeyRequest 

type ApiDeleteByokV1KeyRequest struct {
	ApiService KeysByokV1Api
	// contains filtered or unexported fields
}

func (ApiDeleteByokV1KeyRequest) Execute 

func (r ApiDeleteByokV1KeyRequest) Execute() (*_nethttp.Response, error)

type ApiGetByokV1KeyRequest 

type ApiGetByokV1KeyRequest struct {
	ApiService KeysByokV1Api
	// contains filtered or unexported fields
}

func (ApiGetByokV1KeyRequest) Execute 

func (r ApiGetByokV1KeyRequest) Execute() (ByokV1Key, *_nethttp.Response, error)

type ApiListByokV1KeysRequest 

type ApiListByokV1KeysRequest struct {
	ApiService KeysByokV1Api
	// contains filtered or unexported fields
}

func (ApiListByokV1KeysRequest) Execute 

func (r ApiListByokV1KeysRequest) Execute() (ByokV1KeyList, *_nethttp.Response, error)

func (ApiListByokV1KeysRequest) PageSize 

func (r ApiListByokV1KeysRequest) PageSize(pageSize int32) ApiListByokV1KeysRequest

A pagination size for collection requests.

func (ApiListByokV1KeysRequest) PageToken 

func (r ApiListByokV1KeysRequest) PageToken(pageToken string) ApiListByokV1KeysRequest

An opaque pagination token for collection requests.

func (ApiListByokV1KeysRequest) Provider 

func (r ApiListByokV1KeysRequest) Provider(provider string) ApiListByokV1KeysRequest

Filter the results by exact match for provider.

func (ApiListByokV1KeysRequest) State 

func (r ApiListByokV1KeysRequest) State(state string) ApiListByokV1KeysRequest

Filter the results by exact match for state.

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 ByokV1AwsKey 

type ByokV1AwsKey struct {
	// The Amazon Resource Name (ARN) of an AWS KMS key.
	KeyArn string `json:"key_arn,omitempty"`
	// The Amazon Resource Names (ARNs) of IAM Roles created for this key-environment combination.
	Roles *[]string `json:"roles,omitempty"`
	// BYOK kind type.
	Kind string `json:"kind,omitempty"`
}

ByokV1AwsKey The AWS BYOK details

func NewByokV1AwsKey 

func NewByokV1AwsKey(keyArn string, kind string) *ByokV1AwsKey

NewByokV1AwsKey instantiates a new ByokV1AwsKey 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 NewByokV1AwsKeyWithDefaults 

func NewByokV1AwsKeyWithDefaults() *ByokV1AwsKey

NewByokV1AwsKeyWithDefaults instantiates a new ByokV1AwsKey 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 (*ByokV1AwsKey) GetKeyArn 

func (o *ByokV1AwsKey) GetKeyArn() string

GetKeyArn returns the KeyArn field value

func (*ByokV1AwsKey) GetKeyArnOk 

func (o *ByokV1AwsKey) GetKeyArnOk() (*string, bool)

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

func (*ByokV1AwsKey) GetKind 

func (o *ByokV1AwsKey) GetKind() string

GetKind returns the Kind field value

func (*ByokV1AwsKey) GetKindOk 

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

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

func (*ByokV1AwsKey) GetRoles 

func (o *ByokV1AwsKey) GetRoles() []string

GetRoles returns the Roles field value if set, zero value otherwise.

func (*ByokV1AwsKey) GetRolesOk 

func (o *ByokV1AwsKey) GetRolesOk() (*[]string, bool)

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

func (*ByokV1AwsKey) HasRoles 

func (o *ByokV1AwsKey) HasRoles() bool

HasRoles returns a boolean if a field has been set.

func (ByokV1AwsKey) MarshalJSON 

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

func (*ByokV1AwsKey) Redact 

func (o *ByokV1AwsKey) Redact()

Redact resets all sensitive fields to their zero value.

func (*ByokV1AwsKey) SetKeyArn 

func (o *ByokV1AwsKey) SetKeyArn(v string)

SetKeyArn sets field value

func (*ByokV1AwsKey) SetKind 

func (o *ByokV1AwsKey) SetKind(v string)

SetKind sets field value

func (*ByokV1AwsKey) SetRoles 

func (o *ByokV1AwsKey) SetRoles(v []string)

SetRoles gets a reference to the given []string and assigns it to the Roles field.

type ByokV1AzureKey 

type ByokV1AzureKey struct {
	// The Application ID created for this key-environment combination.
	ApplicationId *string `json:"application_id,omitempty"`
	// The unique Key Object Identifier URL without version of an Azure Key Vault key.
	KeyId string `json:"key_id,omitempty"`
	// Key Vault ID containing the key
	KeyVaultId string `json:"key_vault_id,omitempty"`
	// BYOK kind type.
	Kind string `json:"kind,omitempty"`
	// Tenant ID (uuid) hosting the Key Vault containing the key
	TenantId string `json:"tenant_id,omitempty"`
}

ByokV1AzureKey The Azure BYOK details.

func NewByokV1AzureKey 

func NewByokV1AzureKey(keyId string, keyVaultId string, kind string, tenantId string) *ByokV1AzureKey

NewByokV1AzureKey instantiates a new ByokV1AzureKey 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 NewByokV1AzureKeyWithDefaults 

func NewByokV1AzureKeyWithDefaults() *ByokV1AzureKey

NewByokV1AzureKeyWithDefaults instantiates a new ByokV1AzureKey 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 (*ByokV1AzureKey) GetApplicationId 

func (o *ByokV1AzureKey) GetApplicationId() string

GetApplicationId returns the ApplicationId field value if set, zero value otherwise.

func (*ByokV1AzureKey) GetApplicationIdOk 

func (o *ByokV1AzureKey) GetApplicationIdOk() (*string, bool)

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

func (*ByokV1AzureKey) GetKeyId 

func (o *ByokV1AzureKey) GetKeyId() string

GetKeyId returns the KeyId field value

func (*ByokV1AzureKey) GetKeyIdOk 

func (o *ByokV1AzureKey) GetKeyIdOk() (*string, bool)

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

func (*ByokV1AzureKey) GetKeyVaultId 

func (o *ByokV1AzureKey) GetKeyVaultId() string

GetKeyVaultId returns the KeyVaultId field value

func (*ByokV1AzureKey) GetKeyVaultIdOk 

func (o *ByokV1AzureKey) GetKeyVaultIdOk() (*string, bool)

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

func (*ByokV1AzureKey) GetKind 

func (o *ByokV1AzureKey) GetKind() string

GetKind returns the Kind field value

func (*ByokV1AzureKey) GetKindOk 

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

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

func (*ByokV1AzureKey) GetTenantId 

func (o *ByokV1AzureKey) GetTenantId() string

GetTenantId returns the TenantId field value

func (*ByokV1AzureKey) GetTenantIdOk 

func (o *ByokV1AzureKey) GetTenantIdOk() (*string, bool)

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

func (*ByokV1AzureKey) HasApplicationId 

func (o *ByokV1AzureKey) HasApplicationId() bool

HasApplicationId returns a boolean if a field has been set.

func (ByokV1AzureKey) MarshalJSON 

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

func (*ByokV1AzureKey) Redact 

func (o *ByokV1AzureKey) Redact()

Redact resets all sensitive fields to their zero value.

func (*ByokV1AzureKey) SetApplicationId 

func (o *ByokV1AzureKey) SetApplicationId(v string)

SetApplicationId gets a reference to the given string and assigns it to the ApplicationId field.

func (*ByokV1AzureKey) SetKeyId 

func (o *ByokV1AzureKey) SetKeyId(v string)

SetKeyId sets field value

func (*ByokV1AzureKey) SetKeyVaultId 

func (o *ByokV1AzureKey) SetKeyVaultId(v string)

SetKeyVaultId sets field value

func (*ByokV1AzureKey) SetKind 

func (o *ByokV1AzureKey) SetKind(v string)

SetKind sets field value

func (*ByokV1AzureKey) SetTenantId 

func (o *ByokV1AzureKey) SetTenantId(v string)

SetTenantId sets field value

type ByokV1GcpKey added in v0.0.2 

type ByokV1GcpKey struct {
	// The Google Cloud Platform key ID.
	KeyId string `json:"key_id,omitempty"`
	// The Google security group created for this key.
	SecurityGroup *string `json:"security_group,omitempty"`
	// BYOK kind type.
	Kind string `json:"kind,omitempty"`
}

ByokV1GcpKey The GCP BYOK details

func NewByokV1GcpKey added in v0.0.2 

func NewByokV1GcpKey(keyId string, kind string) *ByokV1GcpKey

NewByokV1GcpKey instantiates a new ByokV1GcpKey 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 NewByokV1GcpKeyWithDefaults added in v0.0.2 

func NewByokV1GcpKeyWithDefaults() *ByokV1GcpKey

NewByokV1GcpKeyWithDefaults instantiates a new ByokV1GcpKey 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 (*ByokV1GcpKey) GetKeyId added in v0.0.2 

func (o *ByokV1GcpKey) GetKeyId() string

GetKeyId returns the KeyId field value

func (*ByokV1GcpKey) GetKeyIdOk added in v0.0.2 

func (o *ByokV1GcpKey) GetKeyIdOk() (*string, bool)

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

func (*ByokV1GcpKey) GetKind added in v0.0.2 

func (o *ByokV1GcpKey) GetKind() string

GetKind returns the Kind field value

func (*ByokV1GcpKey) GetKindOk added in v0.0.2 

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

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

func (*ByokV1GcpKey) GetSecurityGroup added in v0.0.2 

func (o *ByokV1GcpKey) GetSecurityGroup() string

GetSecurityGroup returns the SecurityGroup field value if set, zero value otherwise.

func (*ByokV1GcpKey) GetSecurityGroupOk added in v0.0.2 

func (o *ByokV1GcpKey) GetSecurityGroupOk() (*string, bool)

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

func (*ByokV1GcpKey) HasSecurityGroup added in v0.0.2 

func (o *ByokV1GcpKey) HasSecurityGroup() bool

HasSecurityGroup returns a boolean if a field has been set.

func (ByokV1GcpKey) MarshalJSON added in v0.0.2 

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

func (*ByokV1GcpKey) Redact added in v0.0.2 

func (o *ByokV1GcpKey) Redact()

Redact resets all sensitive fields to their zero value.

func (*ByokV1GcpKey) SetKeyId added in v0.0.2 

func (o *ByokV1GcpKey) SetKeyId(v string)

SetKeyId sets field value

func (*ByokV1GcpKey) SetKind added in v0.0.2 

func (o *ByokV1GcpKey) SetKind(v string)

SetKind sets field value

func (*ByokV1GcpKey) SetSecurityGroup added in v0.0.2 

func (o *ByokV1GcpKey) SetSecurityGroup(v string)

SetSecurityGroup gets a reference to the given string and assigns it to the SecurityGroup field.

type ByokV1Key 

type ByokV1Key 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 cloud-specific key details.  For AWS please provide the corresponding `key_arn`. For Azure please provide the corresponding `key_id`. For GCP please provide the corresponding `key_id`.
	Key *ByokV1KeyKeyOneOf `json:"key,omitempty"`
	// The cloud provider of the Key.
	Provider *string `json:"provider,omitempty"`
	// The state of the key:   AVAILABLE: key can be used for a Kafka cluster provisioning   IN_USE: key is already in use by a Kafka cluster provisioning
	State *string `json:"state,omitempty"`
}

ByokV1Key `Key` objects represent customer managed keys on dedicated Confluent Cloud clusters. Keys are used to protect data at rest stored in your dedicated Confluent Cloud clusters on AWS, Azure and GCP. This API allows you to upload and retrieve self-managed keys on Confluent Cloud. Related guide: [Confluent Cloud Bring Your Own Key (BYOK) Management API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). ## The Keys Model <SchemaDefinition schemaRef=\"#/components/schemas/byok.v1.Key\" /> ## Quotas and Limits This resource is subject to the following quotas: | Quota | Description | | --- | --- | | `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud organisation. |

func NewByokV1Key 

func NewByokV1Key() *ByokV1Key

NewByokV1Key instantiates a new ByokV1Key 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 NewByokV1KeyWithDefaults 

func NewByokV1KeyWithDefaults() *ByokV1Key

NewByokV1KeyWithDefaults instantiates a new ByokV1Key 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 (*ByokV1Key) GetApiVersion 

func (o *ByokV1Key) GetApiVersion() string

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

func (*ByokV1Key) GetApiVersionOk 

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

func (o *ByokV1Key) GetId() string

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

func (*ByokV1Key) GetIdOk 

func (o *ByokV1Key) 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 (*ByokV1Key) GetKey 

func (o *ByokV1Key) GetKey() ByokV1KeyKeyOneOf

GetKey returns the Key field value if set, zero value otherwise.

func (*ByokV1Key) GetKeyOk 

func (o *ByokV1Key) GetKeyOk() (*ByokV1KeyKeyOneOf, bool)

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

func (*ByokV1Key) GetKind 

func (o *ByokV1Key) GetKind() string

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

func (*ByokV1Key) GetKindOk 

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

func (o *ByokV1Key) GetMetadata() ObjectMeta

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

func (*ByokV1Key) GetMetadataOk 

func (o *ByokV1Key) 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 (*ByokV1Key) GetProvider 

func (o *ByokV1Key) GetProvider() string

GetProvider returns the Provider field value if set, zero value otherwise.

func (*ByokV1Key) GetProviderOk 

func (o *ByokV1Key) GetProviderOk() (*string, bool)

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

func (*ByokV1Key) GetState 

func (o *ByokV1Key) GetState() string

GetState returns the State field value if set, zero value otherwise.

func (*ByokV1Key) GetStateOk 

func (o *ByokV1Key) GetStateOk() (*string, bool)

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

func (*ByokV1Key) HasApiVersion 

func (o *ByokV1Key) HasApiVersion() bool

HasApiVersion returns a boolean if a field has been set.

func (*ByokV1Key) HasId 

func (o *ByokV1Key) HasId() bool

HasId returns a boolean if a field has been set.

func (*ByokV1Key) HasKey 

func (o *ByokV1Key) HasKey() bool

HasKey returns a boolean if a field has been set.

func (*ByokV1Key) HasKind 

func (o *ByokV1Key) HasKind() bool

HasKind returns a boolean if a field has been set.

func (*ByokV1Key) HasMetadata 

func (o *ByokV1Key) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*ByokV1Key) HasProvider 

func (o *ByokV1Key) HasProvider() bool

HasProvider returns a boolean if a field has been set.

func (*ByokV1Key) HasState 

func (o *ByokV1Key) HasState() bool

HasState returns a boolean if a field has been set.

func (ByokV1Key) MarshalJSON 

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

func (*ByokV1Key) Redact 

func (o *ByokV1Key) Redact()

Redact resets all sensitive fields to their zero value.

func (*ByokV1Key) SetApiVersion 

func (o *ByokV1Key) SetApiVersion(v string)

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

func (*ByokV1Key) SetId 

func (o *ByokV1Key) SetId(v string)

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

func (*ByokV1Key) SetKey 

func (o *ByokV1Key) SetKey(v ByokV1KeyKeyOneOf)

SetKey gets a reference to the given ByokV1KeyKeyOneOf and assigns it to the Key field.

func (*ByokV1Key) SetKind 

func (o *ByokV1Key) SetKind(v string)

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

func (*ByokV1Key) SetMetadata 

func (o *ByokV1Key) SetMetadata(v ObjectMeta)

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

func (*ByokV1Key) SetProvider 

func (o *ByokV1Key) SetProvider(v string)

SetProvider gets a reference to the given string and assigns it to the Provider field.

func (*ByokV1Key) SetState 

func (o *ByokV1Key) SetState(v string)

SetState gets a reference to the given string and assigns it to the State field.

type ByokV1KeyKeyOneOf 

type ByokV1KeyKeyOneOf struct {
	ByokV1AwsKey   *ByokV1AwsKey
	ByokV1AzureKey *ByokV1AzureKey
	ByokV1GcpKey   *ByokV1GcpKey
}

ByokV1KeyKeyOneOf - struct for ByokV1KeyKeyOneOf

func ByokV1AwsKeyAsByokV1KeyKeyOneOf 

func ByokV1AwsKeyAsByokV1KeyKeyOneOf(v *ByokV1AwsKey) ByokV1KeyKeyOneOf

ByokV1AwsKeyAsByokV1KeyKeyOneOf is a convenience function that returns ByokV1AwsKey wrapped in ByokV1KeyKeyOneOf

func ByokV1AzureKeyAsByokV1KeyKeyOneOf 

func ByokV1AzureKeyAsByokV1KeyKeyOneOf(v *ByokV1AzureKey) ByokV1KeyKeyOneOf

ByokV1AzureKeyAsByokV1KeyKeyOneOf is a convenience function that returns ByokV1AzureKey wrapped in ByokV1KeyKeyOneOf

func ByokV1GcpKeyAsByokV1KeyKeyOneOf added in v0.0.2 

func ByokV1GcpKeyAsByokV1KeyKeyOneOf(v *ByokV1GcpKey) ByokV1KeyKeyOneOf

ByokV1GcpKeyAsByokV1KeyKeyOneOf is a convenience function that returns ByokV1GcpKey wrapped in ByokV1KeyKeyOneOf

func (*ByokV1KeyKeyOneOf) GetActualInstance 

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

Get the actual instance

func (ByokV1KeyKeyOneOf) MarshalJSON 

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

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

func (*ByokV1KeyKeyOneOf) UnmarshalJSON 

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

Unmarshal JSON data into one of the pointers in the struct

type ByokV1KeyList 

type ByokV1KeyList 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"`
	Metadata ListMeta `json:"metadata,omitempty"`
	// A data property that contains an array of resource items. Each entry in the array is a separate resource.
	Data []ByokV1Key `json:"data,omitempty"`
}

ByokV1KeyList `Key` objects represent customer managed keys on dedicated Confluent Cloud clusters. Keys are used to protect data at rest stored in your dedicated Confluent Cloud clusters on AWS, Azure and GCP. This API allows you to upload and retrieve self-managed keys on Confluent Cloud. Related guide: [Confluent Cloud Bring Your Own Key (BYOK) Management API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). ## The Keys Model <SchemaDefinition schemaRef=\"#/components/schemas/byok.v1.Key\" /> ## Quotas and Limits This resource is subject to the following quotas: | Quota | Description | | --- | --- | | `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud organisation. |

func NewByokV1KeyList 

func NewByokV1KeyList(apiVersion string, kind string, metadata ListMeta, data []ByokV1Key) *ByokV1KeyList

NewByokV1KeyList instantiates a new ByokV1KeyList 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 NewByokV1KeyListWithDefaults 

func NewByokV1KeyListWithDefaults() *ByokV1KeyList

NewByokV1KeyListWithDefaults instantiates a new ByokV1KeyList 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 (*ByokV1KeyList) GetApiVersion 

func (o *ByokV1KeyList) GetApiVersion() string

GetApiVersion returns the ApiVersion field value

func (*ByokV1KeyList) GetApiVersionOk 

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

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

func (*ByokV1KeyList) GetData 

func (o *ByokV1KeyList) GetData() []ByokV1Key

GetData returns the Data field value

func (*ByokV1KeyList) GetDataOk 

func (o *ByokV1KeyList) GetDataOk() (*[]ByokV1Key, bool)

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

func (*ByokV1KeyList) GetKind 

func (o *ByokV1KeyList) GetKind() string

GetKind returns the Kind field value

func (*ByokV1KeyList) GetKindOk 

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

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

func (*ByokV1KeyList) GetMetadata 

func (o *ByokV1KeyList) GetMetadata() ListMeta

GetMetadata returns the Metadata field value

func (*ByokV1KeyList) GetMetadataOk 

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

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

func (ByokV1KeyList) MarshalJSON 

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

func (*ByokV1KeyList) Redact 

func (o *ByokV1KeyList) Redact()

Redact resets all sensitive fields to their zero value.

func (*ByokV1KeyList) SetApiVersion 

func (o *ByokV1KeyList) SetApiVersion(v string)

SetApiVersion sets field value

func (*ByokV1KeyList) SetData 

func (o *ByokV1KeyList) SetData(v []ByokV1Key)

SetData sets field value

func (*ByokV1KeyList) SetKind 

func (o *ByokV1KeyList) SetKind(v string)

SetKind sets field value

func (*ByokV1KeyList) SetMetadata 

func (o *ByokV1KeyList) SetMetadata(v ListMeta)

SetMetadata sets field value

type Configuration 

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

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

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

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

func (*Configuration) ServerURL 

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

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext 

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

ServerURLWithContext returns a new server URL given an endpoint

type 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 KeysByokV1Api 

type KeysByokV1Api interface {

	/*
			CreateByokV1Key Create a Key

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

		Make a request to create a key.

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

	// CreateByokV1KeyExecute executes the request
	//  @return ByokV1Key
	CreateByokV1KeyExecute(r ApiCreateByokV1KeyRequest) (ByokV1Key, *_nethttp.Response, error)

	/*
			DeleteByokV1Key Delete a Key

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

		Make a request to delete a key.

			 @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 key.
			 @return ApiDeleteByokV1KeyRequest
	*/
	DeleteByokV1Key(ctx _context.Context, id string) ApiDeleteByokV1KeyRequest

	// DeleteByokV1KeyExecute executes the request
	DeleteByokV1KeyExecute(r ApiDeleteByokV1KeyRequest) (*_nethttp.Response, error)

	/*
			GetByokV1Key Read a Key

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

		Make a request to read a key.

			 @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 key.
			 @return ApiGetByokV1KeyRequest
	*/
	GetByokV1Key(ctx _context.Context, id string) ApiGetByokV1KeyRequest

	// GetByokV1KeyExecute executes the request
	//  @return ByokV1Key
	GetByokV1KeyExecute(r ApiGetByokV1KeyRequest) (ByokV1Key, *_nethttp.Response, error)

	/*
			ListByokV1Keys List of Keys

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

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

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

	// ListByokV1KeysExecute executes the request
	//  @return ByokV1KeyList
	ListByokV1KeysExecute(r ApiListByokV1KeysRequest) (ByokV1KeyList, *_nethttp.Response, error)
}

type KeysByokV1ApiService 

type KeysByokV1ApiService service

KeysByokV1ApiService KeysByokV1Api service

func (*KeysByokV1ApiService) CreateByokV1Key 

func (a *KeysByokV1ApiService) CreateByokV1Key(ctx _context.Context) ApiCreateByokV1KeyRequest

CreateByokV1Key Create a Key

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

Make a request to create a key. 

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

func (*KeysByokV1ApiService) CreateByokV1KeyExecute 

func (a *KeysByokV1ApiService) CreateByokV1KeyExecute(r ApiCreateByokV1KeyRequest) (ByokV1Key, *_nethttp.Response, error)

Execute executes the request 

@return ByokV1Key

func (*KeysByokV1ApiService) DeleteByokV1Key 

func (a *KeysByokV1ApiService) DeleteByokV1Key(ctx _context.Context, id string) ApiDeleteByokV1KeyRequest

DeleteByokV1Key Delete a Key

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

Make a request to delete a key. 

@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 key.
@return ApiDeleteByokV1KeyRequest

func (*KeysByokV1ApiService) DeleteByokV1KeyExecute 

func (a *KeysByokV1ApiService) DeleteByokV1KeyExecute(r ApiDeleteByokV1KeyRequest) (*_nethttp.Response, error)

Execute executes the request

func (*KeysByokV1ApiService) GetByokV1Key 

func (a *KeysByokV1ApiService) GetByokV1Key(ctx _context.Context, id string) ApiGetByokV1KeyRequest

GetByokV1Key Read a Key

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

Make a request to read a key. 

@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 key.
@return ApiGetByokV1KeyRequest

func (*KeysByokV1ApiService) GetByokV1KeyExecute 

func (a *KeysByokV1ApiService) GetByokV1KeyExecute(r ApiGetByokV1KeyRequest) (ByokV1Key, *_nethttp.Response, error)

Execute executes the request 

@return ByokV1Key

func (*KeysByokV1ApiService) ListByokV1Keys 

func (a *KeysByokV1ApiService) ListByokV1Keys(ctx _context.Context) ApiListByokV1KeysRequest

ListByokV1Keys List of Keys

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

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

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

func (*KeysByokV1ApiService) ListByokV1KeysExecute 

func (a *KeysByokV1ApiService) ListByokV1KeysExecute(r ApiListByokV1KeysRequest) (ByokV1KeyList, *_nethttp.Response, error)

Execute executes the request 

@return ByokV1KeyList

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 NullableByokV1AwsKey 

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

func NewNullableByokV1AwsKey 

func NewNullableByokV1AwsKey(val *ByokV1AwsKey) *NullableByokV1AwsKey

func (NullableByokV1AwsKey) Get 

func (v NullableByokV1AwsKey) Get() *ByokV1AwsKey

func (NullableByokV1AwsKey) IsSet 

func (v NullableByokV1AwsKey) IsSet() bool

func (NullableByokV1AwsKey) MarshalJSON 

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

func (*NullableByokV1AwsKey) Set 

func (v *NullableByokV1AwsKey) Set(val *ByokV1AwsKey)

func (*NullableByokV1AwsKey) UnmarshalJSON 

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

func (*NullableByokV1AwsKey) Unset 

func (v *NullableByokV1AwsKey) Unset()

type NullableByokV1AzureKey 

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

func NewNullableByokV1AzureKey 

func NewNullableByokV1AzureKey(val *ByokV1AzureKey) *NullableByokV1AzureKey

func (NullableByokV1AzureKey) Get 

func (v NullableByokV1AzureKey) Get() *ByokV1AzureKey

func (NullableByokV1AzureKey) IsSet 

func (v NullableByokV1AzureKey) IsSet() bool

func (NullableByokV1AzureKey) MarshalJSON 

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

func (*NullableByokV1AzureKey) Set 

func (v *NullableByokV1AzureKey) Set(val *ByokV1AzureKey)

func (*NullableByokV1AzureKey) UnmarshalJSON 

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

func (*NullableByokV1AzureKey) Unset 

func (v *NullableByokV1AzureKey) Unset()

type NullableByokV1GcpKey added in v0.0.2 

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

func NewNullableByokV1GcpKey added in v0.0.2 

func NewNullableByokV1GcpKey(val *ByokV1GcpKey) *NullableByokV1GcpKey

func (NullableByokV1GcpKey) Get added in v0.0.2 

func (v NullableByokV1GcpKey) Get() *ByokV1GcpKey

func (NullableByokV1GcpKey) IsSet added in v0.0.2 

func (v NullableByokV1GcpKey) IsSet() bool

func (NullableByokV1GcpKey) MarshalJSON added in v0.0.2 

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

func (*NullableByokV1GcpKey) Set added in v0.0.2 

func (v *NullableByokV1GcpKey) Set(val *ByokV1GcpKey)

func (*NullableByokV1GcpKey) UnmarshalJSON added in v0.0.2 

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

func (*NullableByokV1GcpKey) Unset added in v0.0.2 

func (v *NullableByokV1GcpKey) Unset()

type NullableByokV1Key 

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

func NewNullableByokV1Key 

func NewNullableByokV1Key(val *ByokV1Key) *NullableByokV1Key

func (NullableByokV1Key) Get 

func (v NullableByokV1Key) Get() *ByokV1Key

func (NullableByokV1Key) IsSet 

func (v NullableByokV1Key) IsSet() bool

func (NullableByokV1Key) MarshalJSON 

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

func (*NullableByokV1Key) Set 

func (v *NullableByokV1Key) Set(val *ByokV1Key)

func (*NullableByokV1Key) UnmarshalJSON 

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

func (*NullableByokV1Key) Unset 

func (v *NullableByokV1Key) Unset()

type NullableByokV1KeyKeyOneOf 

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

func NewNullableByokV1KeyKeyOneOf 

func NewNullableByokV1KeyKeyOneOf(val *ByokV1KeyKeyOneOf) *NullableByokV1KeyKeyOneOf

func (NullableByokV1KeyKeyOneOf) Get 

func (v NullableByokV1KeyKeyOneOf) Get() *ByokV1KeyKeyOneOf

func (NullableByokV1KeyKeyOneOf) IsSet 

func (v NullableByokV1KeyKeyOneOf) IsSet() bool

func (NullableByokV1KeyKeyOneOf) MarshalJSON 

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

func (*NullableByokV1KeyKeyOneOf) Set 

func (v *NullableByokV1KeyKeyOneOf) Set(val *ByokV1KeyKeyOneOf)

func (*NullableByokV1KeyKeyOneOf) UnmarshalJSON 

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

func (*NullableByokV1KeyKeyOneOf) Unset 

func (v *NullableByokV1KeyKeyOneOf) Unset()

type NullableByokV1KeyList 

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

func NewNullableByokV1KeyList 

func NewNullableByokV1KeyList(val *ByokV1KeyList) *NullableByokV1KeyList

func (NullableByokV1KeyList) Get 

func (v NullableByokV1KeyList) Get() *ByokV1KeyList

func (NullableByokV1KeyList) IsSet 

func (v NullableByokV1KeyList) IsSet() bool

func (NullableByokV1KeyList) MarshalJSON 

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

func (*NullableByokV1KeyList) Set 

func (v *NullableByokV1KeyList) Set(val *ByokV1KeyList)

func (*NullableByokV1KeyList) UnmarshalJSON 

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

func (*NullableByokV1KeyList) Unset 

func (v *NullableByokV1KeyList) 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 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 (v NullableObjectReference) Get() *ObjectReference

func (NullableObjectReference) IsSet 

func (v NullableObjectReference) IsSet() bool

func (NullableObjectReference) MarshalJSON 

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

func (*NullableObjectReference) Set 

func (v *NullableObjectReference) Set(val *ObjectReference)

func (*NullableObjectReference) UnmarshalJSON 

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

func (*NullableObjectReference) Unset 

func (v *NullableObjectReference) 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 ObjectReference 

type ObjectReference struct {
	// ID of the referred resource
	Id string `json:"id,omitempty"`
	// 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,omitempty"`
	// CRN reference to the referred resource
	ResourceName string `json:"resource_name,omitempty"`
	// 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 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

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.