serviceaccountsclient

package
v0.5.0 Latest Latest
Warning

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

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

README

Go API client for serviceaccountsclient

This is the API documentation for Service Accounts

Overview

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

  • API version: 5.0.19
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

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

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 identifield 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://sso.redhat.com/auth/realms/redhat-external

Class Method HTTP request Description
ServiceAccountsApi CreateServiceAccount Post /apis/service_accounts/v1 Create service account
ServiceAccountsApi DeleteServiceAccount Delete /apis/service_accounts/v1/{id} Delete service account by id
ServiceAccountsApi GetServiceAccount Get /apis/service_accounts/v1/{id} Get service account by id
ServiceAccountsApi GetServiceAccounts Get /apis/service_accounts/v1 List all service accounts
ServiceAccountsApi ResetServiceAccountSecret Post /apis/service_accounts/v1/{id}/resetSecret Reset service account secret by id
ServiceAccountsApi UpdateServiceAccount Patch /apis/service_accounts/v1/{id} Update service account

Documentation For Models

Documentation For Authorization

authFlow
  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: /auth/realms/redhat-external/protocol/openid-connect/auth
  • Scopes:
  • openid: Treat as an OIDC request
  • api.iam.service_accounts: Grants access to the service accounts api

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)
bearerAuth
  • Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARERTOKENSTRING")
r, err := client.Service.Operation(auth, args)
serviceAccounts
  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
  • openid: Treat as an OIDC request
  • api.iam.service_accounts: Grants access to the service accounts api

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
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

it-user-team-list@redhat.com

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 {
	ServiceAccountsApi ServiceAccountsApi
	// contains filtered or unexported fields
}

APIClient manages communication with the Service Accounts API Documentation API v5.0.19 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 ApiCreateServiceAccountRequest

type ApiCreateServiceAccountRequest struct {
	ApiService ServiceAccountsApi
	// contains filtered or unexported fields
}

func (ApiCreateServiceAccountRequest) Execute

func (ApiCreateServiceAccountRequest) ServiceAccountCreateRequestData

func (r ApiCreateServiceAccountRequest) ServiceAccountCreateRequestData(serviceAccountCreateRequestData ServiceAccountCreateRequestData) ApiCreateServiceAccountRequest

type ApiDeleteServiceAccountRequest

type ApiDeleteServiceAccountRequest struct {
	ApiService ServiceAccountsApi
	// contains filtered or unexported fields
}

func (ApiDeleteServiceAccountRequest) Execute

type ApiGetServiceAccountRequest

type ApiGetServiceAccountRequest struct {
	ApiService ServiceAccountsApi
	// contains filtered or unexported fields
}

func (ApiGetServiceAccountRequest) Execute

type ApiGetServiceAccountsRequest

type ApiGetServiceAccountsRequest struct {
	ApiService ServiceAccountsApi
	// contains filtered or unexported fields
}

func (ApiGetServiceAccountsRequest) ClientId added in v0.4.0

func (ApiGetServiceAccountsRequest) Execute

func (ApiGetServiceAccountsRequest) First

func (ApiGetServiceAccountsRequest) Max

type ApiResetServiceAccountSecretRequest

type ApiResetServiceAccountSecretRequest struct {
	ApiService ServiceAccountsApi
	// contains filtered or unexported fields
}

func (ApiResetServiceAccountSecretRequest) Execute

type ApiUpdateServiceAccountRequest

type ApiUpdateServiceAccountRequest struct {
	ApiService ServiceAccountsApi
	// contains filtered or unexported fields
}

func (ApiUpdateServiceAccountRequest) Execute

func (ApiUpdateServiceAccountRequest) ServiceAccountRequestData

func (r ApiUpdateServiceAccountRequest) ServiceAccountRequestData(serviceAccountRequestData ServiceAccountRequestData) ApiUpdateServiceAccountRequest

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 {
	// The cause of the Error.
	Error string `json:"error"`
}

Error struct for Error

func NewError

func NewError(error_ string) *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) GetError

func (o *Error) GetError() string

GetError returns the Error field value

func (*Error) GetErrorOk

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

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

func (Error) MarshalJSON

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

func (*Error) SetError

func (o *Error) SetError(v string)

SetError 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 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 NullableRedHatErrorRepresentation added in v0.5.0

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

func NewNullableRedHatErrorRepresentation added in v0.5.0

func NewNullableRedHatErrorRepresentation(val *RedHatErrorRepresentation) *NullableRedHatErrorRepresentation

func (NullableRedHatErrorRepresentation) Get added in v0.5.0

func (NullableRedHatErrorRepresentation) IsSet added in v0.5.0

func (NullableRedHatErrorRepresentation) MarshalJSON added in v0.5.0

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

func (*NullableRedHatErrorRepresentation) Set added in v0.5.0

func (*NullableRedHatErrorRepresentation) UnmarshalJSON added in v0.5.0

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

func (*NullableRedHatErrorRepresentation) Unset added in v0.5.0

type NullableServiceAccountCreateRequestData

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

func (NullableServiceAccountCreateRequestData) Get

func (NullableServiceAccountCreateRequestData) IsSet

func (NullableServiceAccountCreateRequestData) MarshalJSON

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

func (*NullableServiceAccountCreateRequestData) Set

func (*NullableServiceAccountCreateRequestData) UnmarshalJSON

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

func (*NullableServiceAccountCreateRequestData) Unset

type NullableServiceAccountData

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

func NewNullableServiceAccountData

func NewNullableServiceAccountData(val *ServiceAccountData) *NullableServiceAccountData

func (NullableServiceAccountData) Get

func (NullableServiceAccountData) IsSet

func (v NullableServiceAccountData) IsSet() bool

func (NullableServiceAccountData) MarshalJSON

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

func (*NullableServiceAccountData) Set

func (*NullableServiceAccountData) UnmarshalJSON

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

func (*NullableServiceAccountData) Unset

func (v *NullableServiceAccountData) Unset()

type NullableServiceAccountRequestData

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

func (NullableServiceAccountRequestData) Get

func (NullableServiceAccountRequestData) IsSet

func (NullableServiceAccountRequestData) MarshalJSON

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

func (*NullableServiceAccountRequestData) Set

func (*NullableServiceAccountRequestData) UnmarshalJSON

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

func (*NullableServiceAccountRequestData) 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 NullableValidationExceptionData added in v0.5.0

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

func NewNullableValidationExceptionData added in v0.5.0

func NewNullableValidationExceptionData(val *ValidationExceptionData) *NullableValidationExceptionData

func (NullableValidationExceptionData) Get added in v0.5.0

func (NullableValidationExceptionData) IsSet added in v0.5.0

func (NullableValidationExceptionData) MarshalJSON added in v0.5.0

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

func (*NullableValidationExceptionData) Set added in v0.5.0

func (*NullableValidationExceptionData) UnmarshalJSON added in v0.5.0

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

func (*NullableValidationExceptionData) Unset added in v0.5.0

type RedHatErrorRepresentation added in v0.5.0

type RedHatErrorRepresentation struct {
	Error            *string `json:"error,omitempty"`
	ErrorDescription *string `json:"error_description,omitempty"`
}

RedHatErrorRepresentation struct for RedHatErrorRepresentation

func NewRedHatErrorRepresentation added in v0.5.0

func NewRedHatErrorRepresentation() *RedHatErrorRepresentation

NewRedHatErrorRepresentation instantiates a new RedHatErrorRepresentation 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 NewRedHatErrorRepresentationWithDefaults added in v0.5.0

func NewRedHatErrorRepresentationWithDefaults() *RedHatErrorRepresentation

NewRedHatErrorRepresentationWithDefaults instantiates a new RedHatErrorRepresentation 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 (*RedHatErrorRepresentation) GetError added in v0.5.0

func (o *RedHatErrorRepresentation) GetError() string

GetError returns the Error field value if set, zero value otherwise.

func (*RedHatErrorRepresentation) GetErrorDescription added in v0.5.0

func (o *RedHatErrorRepresentation) GetErrorDescription() string

GetErrorDescription returns the ErrorDescription field value if set, zero value otherwise.

func (*RedHatErrorRepresentation) GetErrorDescriptionOk added in v0.5.0

func (o *RedHatErrorRepresentation) GetErrorDescriptionOk() (*string, bool)

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

func (*RedHatErrorRepresentation) GetErrorOk added in v0.5.0

func (o *RedHatErrorRepresentation) GetErrorOk() (*string, bool)

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

func (*RedHatErrorRepresentation) HasError added in v0.5.0

func (o *RedHatErrorRepresentation) HasError() bool

HasError returns a boolean if a field has been set.

func (*RedHatErrorRepresentation) HasErrorDescription added in v0.5.0

func (o *RedHatErrorRepresentation) HasErrorDescription() bool

HasErrorDescription returns a boolean if a field has been set.

func (RedHatErrorRepresentation) MarshalJSON added in v0.5.0

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

func (*RedHatErrorRepresentation) SetError added in v0.5.0

func (o *RedHatErrorRepresentation) SetError(v string)

SetError gets a reference to the given string and assigns it to the Error field.

func (*RedHatErrorRepresentation) SetErrorDescription added in v0.5.0

func (o *RedHatErrorRepresentation) SetErrorDescription(v string)

SetErrorDescription gets a reference to the given string and assigns it to the ErrorDescription 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 ServiceAccountCreateRequestData

type ServiceAccountCreateRequestData struct {
	Name        string  `json:"name"`
	Description *string `json:"description,omitempty"`
}

ServiceAccountCreateRequestData struct for ServiceAccountCreateRequestData

func NewServiceAccountCreateRequestData

func NewServiceAccountCreateRequestData(name string) *ServiceAccountCreateRequestData

NewServiceAccountCreateRequestData instantiates a new ServiceAccountCreateRequestData 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 NewServiceAccountCreateRequestDataWithDefaults

func NewServiceAccountCreateRequestDataWithDefaults() *ServiceAccountCreateRequestData

NewServiceAccountCreateRequestDataWithDefaults instantiates a new ServiceAccountCreateRequestData 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 (*ServiceAccountCreateRequestData) GetDescription

func (o *ServiceAccountCreateRequestData) GetDescription() string

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

func (*ServiceAccountCreateRequestData) GetDescriptionOk

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

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

func (*ServiceAccountCreateRequestData) GetName

GetName returns the Name field value

func (*ServiceAccountCreateRequestData) GetNameOk

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

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

func (*ServiceAccountCreateRequestData) HasDescription added in v0.5.0

func (o *ServiceAccountCreateRequestData) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (ServiceAccountCreateRequestData) MarshalJSON

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

func (*ServiceAccountCreateRequestData) SetDescription

func (o *ServiceAccountCreateRequestData) SetDescription(v string)

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

func (*ServiceAccountCreateRequestData) SetName

SetName sets field value

type ServiceAccountData

type ServiceAccountData struct {
	Id       *string `json:"id,omitempty"`
	ClientId *string `json:"clientId,omitempty"`
	// Provided during creation and resetting of service account credentials.
	Secret      *string `json:"secret,omitempty"`
	Name        *string `json:"name,omitempty"`
	Description *string `json:"description,omitempty"`
	CreatedBy   *string `json:"createdBy,omitempty"`
	CreatedAt   *int64  `json:"createdAt,omitempty"`
}

ServiceAccountData struct for ServiceAccountData

func NewServiceAccountData

func NewServiceAccountData() *ServiceAccountData

NewServiceAccountData instantiates a new ServiceAccountData 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 NewServiceAccountDataWithDefaults

func NewServiceAccountDataWithDefaults() *ServiceAccountData

NewServiceAccountDataWithDefaults instantiates a new ServiceAccountData 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 (*ServiceAccountData) GetClientId

func (o *ServiceAccountData) GetClientId() string

GetClientId returns the ClientId field value if set, zero value otherwise.

func (*ServiceAccountData) GetClientIdOk

func (o *ServiceAccountData) GetClientIdOk() (*string, bool)

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

func (*ServiceAccountData) GetCreatedAt

func (o *ServiceAccountData) GetCreatedAt() int64

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

func (*ServiceAccountData) GetCreatedAtOk

func (o *ServiceAccountData) GetCreatedAtOk() (*int64, 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 (*ServiceAccountData) GetCreatedBy added in v0.4.0

func (o *ServiceAccountData) GetCreatedBy() string

GetCreatedBy returns the CreatedBy field value if set, zero value otherwise.

func (*ServiceAccountData) GetCreatedByOk added in v0.4.0

func (o *ServiceAccountData) GetCreatedByOk() (*string, bool)

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

func (*ServiceAccountData) GetDescription

func (o *ServiceAccountData) GetDescription() string

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

func (*ServiceAccountData) GetDescriptionOk

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

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

func (*ServiceAccountData) GetId

func (o *ServiceAccountData) GetId() string

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

func (*ServiceAccountData) GetIdOk

func (o *ServiceAccountData) 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 (*ServiceAccountData) GetName

func (o *ServiceAccountData) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*ServiceAccountData) GetNameOk

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

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

func (*ServiceAccountData) GetSecret

func (o *ServiceAccountData) GetSecret() string

GetSecret returns the Secret field value if set, zero value otherwise.

func (*ServiceAccountData) GetSecretOk

func (o *ServiceAccountData) GetSecretOk() (*string, bool)

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

func (*ServiceAccountData) HasClientId

func (o *ServiceAccountData) HasClientId() bool

HasClientId returns a boolean if a field has been set.

func (*ServiceAccountData) HasCreatedAt

func (o *ServiceAccountData) HasCreatedAt() bool

HasCreatedAt returns a boolean if a field has been set.

func (*ServiceAccountData) HasCreatedBy added in v0.4.0

func (o *ServiceAccountData) HasCreatedBy() bool

HasCreatedBy returns a boolean if a field has been set.

func (*ServiceAccountData) HasDescription

func (o *ServiceAccountData) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*ServiceAccountData) HasId

func (o *ServiceAccountData) HasId() bool

HasId returns a boolean if a field has been set.

func (*ServiceAccountData) HasName

func (o *ServiceAccountData) HasName() bool

HasName returns a boolean if a field has been set.

func (*ServiceAccountData) HasSecret

func (o *ServiceAccountData) HasSecret() bool

HasSecret returns a boolean if a field has been set.

func (ServiceAccountData) MarshalJSON

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

func (*ServiceAccountData) SetClientId

func (o *ServiceAccountData) SetClientId(v string)

SetClientId gets a reference to the given string and assigns it to the ClientId field.

func (*ServiceAccountData) SetCreatedAt

func (o *ServiceAccountData) SetCreatedAt(v int64)

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

func (*ServiceAccountData) SetCreatedBy added in v0.4.0

func (o *ServiceAccountData) SetCreatedBy(v string)

SetCreatedBy gets a reference to the given string and assigns it to the CreatedBy field.

func (*ServiceAccountData) SetDescription

func (o *ServiceAccountData) SetDescription(v string)

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

func (*ServiceAccountData) SetId

func (o *ServiceAccountData) SetId(v string)

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

func (*ServiceAccountData) SetName

func (o *ServiceAccountData) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

func (*ServiceAccountData) SetSecret

func (o *ServiceAccountData) SetSecret(v string)

SetSecret gets a reference to the given string and assigns it to the Secret field.

type ServiceAccountRequestData

type ServiceAccountRequestData struct {
	Name        *string `json:"name,omitempty"`
	Description *string `json:"description,omitempty"`
}

ServiceAccountRequestData struct for ServiceAccountRequestData

func NewServiceAccountRequestData

func NewServiceAccountRequestData() *ServiceAccountRequestData

NewServiceAccountRequestData instantiates a new ServiceAccountRequestData 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 NewServiceAccountRequestDataWithDefaults

func NewServiceAccountRequestDataWithDefaults() *ServiceAccountRequestData

NewServiceAccountRequestDataWithDefaults instantiates a new ServiceAccountRequestData 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 (*ServiceAccountRequestData) GetDescription

func (o *ServiceAccountRequestData) GetDescription() string

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

func (*ServiceAccountRequestData) GetDescriptionOk

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

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

func (*ServiceAccountRequestData) GetName

func (o *ServiceAccountRequestData) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*ServiceAccountRequestData) GetNameOk

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

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

func (*ServiceAccountRequestData) HasDescription

func (o *ServiceAccountRequestData) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*ServiceAccountRequestData) HasName

func (o *ServiceAccountRequestData) HasName() bool

HasName returns a boolean if a field has been set.

func (ServiceAccountRequestData) MarshalJSON

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

func (*ServiceAccountRequestData) SetDescription

func (o *ServiceAccountRequestData) SetDescription(v string)

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

func (*ServiceAccountRequestData) SetName

func (o *ServiceAccountRequestData) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

type ServiceAccountsApi

type ServiceAccountsApi interface {

	/*
	 * CreateServiceAccount Create service account
	 * Create a service account. Created service account is associated with the user defined in the bearer token.
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return ApiCreateServiceAccountRequest
	 */
	CreateServiceAccount(ctx _context.Context) ApiCreateServiceAccountRequest

	/*
	 * CreateServiceAccountExecute executes the request
	 * @return ServiceAccountData
	 */
	CreateServiceAccountExecute(r ApiCreateServiceAccountRequest) (ServiceAccountData, *_nethttp.Response, error)

	/*
	 * DeleteServiceAccount Delete service account by id
	 * Delete service account by id. Throws not found exception if the service account is not found or the user does not have access to this service account
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param id
	 * @return ApiDeleteServiceAccountRequest
	 */
	DeleteServiceAccount(ctx _context.Context, id string) ApiDeleteServiceAccountRequest

	/*
	 * DeleteServiceAccountExecute executes the request
	 */
	DeleteServiceAccountExecute(r ApiDeleteServiceAccountRequest) (*_nethttp.Response, error)

	/*
	 * GetServiceAccount Get service account by id
	 * Returns service account by id. Throws not found exception if the service account is not found or the user does not have access to this service account
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param id
	 * @return ApiGetServiceAccountRequest
	 */
	GetServiceAccount(ctx _context.Context, id string) ApiGetServiceAccountRequest

	/*
	 * GetServiceAccountExecute executes the request
	 * @return ServiceAccountData
	 */
	GetServiceAccountExecute(r ApiGetServiceAccountRequest) (ServiceAccountData, *_nethttp.Response, error)

	/*
	 * GetServiceAccounts List all service accounts
	 * Returns a list of service accounts created by a user. User information is obtained from the bearer token. The list is paginated with starting index as 'first' and page size as 'max'.
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @return ApiGetServiceAccountsRequest
	 */
	GetServiceAccounts(ctx _context.Context) ApiGetServiceAccountsRequest

	/*
	 * GetServiceAccountsExecute executes the request
	 * @return []ServiceAccountData
	 */
	GetServiceAccountsExecute(r ApiGetServiceAccountsRequest) ([]ServiceAccountData, *_nethttp.Response, error)

	/*
	 * ResetServiceAccountSecret Reset service account secret by id
	 * Reset service account secret by id . Throws not found exception if the service account is not found or the user does not have access to this service account
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param id
	 * @return ApiResetServiceAccountSecretRequest
	 */
	ResetServiceAccountSecret(ctx _context.Context, id string) ApiResetServiceAccountSecretRequest

	/*
	 * ResetServiceAccountSecretExecute executes the request
	 * @return ServiceAccountData
	 */
	ResetServiceAccountSecretExecute(r ApiResetServiceAccountSecretRequest) (ServiceAccountData, *_nethttp.Response, error)

	/*
	 * UpdateServiceAccount Update service account
	 * Update a service account by id.
	 * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
	 * @param id
	 * @return ApiUpdateServiceAccountRequest
	 */
	UpdateServiceAccount(ctx _context.Context, id string) ApiUpdateServiceAccountRequest

	/*
	 * UpdateServiceAccountExecute executes the request
	 * @return ServiceAccountData
	 */
	UpdateServiceAccountExecute(r ApiUpdateServiceAccountRequest) (ServiceAccountData, *_nethttp.Response, error)
}

type ServiceAccountsApiService

type ServiceAccountsApiService service

ServiceAccountsApiService ServiceAccountsApi service

func (*ServiceAccountsApiService) CreateServiceAccount

* CreateServiceAccount Create service account * Create a service account. Created service account is associated with the user defined in the bearer token. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @return ApiCreateServiceAccountRequest

func (*ServiceAccountsApiService) CreateServiceAccountExecute

* Execute executes the request * @return ServiceAccountData

func (*ServiceAccountsApiService) DeleteServiceAccount

* DeleteServiceAccount Delete service account by id * Delete service account by id. Throws not found exception if the service account is not found or the user does not have access to this service account * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param id * @return ApiDeleteServiceAccountRequest

func (*ServiceAccountsApiService) DeleteServiceAccountExecute

func (a *ServiceAccountsApiService) DeleteServiceAccountExecute(r ApiDeleteServiceAccountRequest) (*_nethttp.Response, error)

* Execute executes the request

func (*ServiceAccountsApiService) GetServiceAccount added in v0.3.0

* GetServiceAccount Get service account by id * Returns service account by id. Throws not found exception if the service account is not found or the user does not have access to this service account * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param id * @return ApiGetServiceAccountRequest

func (*ServiceAccountsApiService) GetServiceAccountExecute added in v0.3.0

* Execute executes the request * @return ServiceAccountData

func (*ServiceAccountsApiService) GetServiceAccounts

* GetServiceAccounts List all service accounts * Returns a list of service accounts created by a user. User information is obtained from the bearer token. The list is paginated with starting index as 'first' and page size as 'max'. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @return ApiGetServiceAccountsRequest

func (*ServiceAccountsApiService) GetServiceAccountsExecute

* Execute executes the request * @return []ServiceAccountData

func (*ServiceAccountsApiService) ResetServiceAccountSecret added in v0.3.0

* ResetServiceAccountSecret Reset service account secret by id * Reset service account secret by id . Throws not found exception if the service account is not found or the user does not have access to this service account * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param id * @return ApiResetServiceAccountSecretRequest

func (*ServiceAccountsApiService) ResetServiceAccountSecretExecute added in v0.3.0

* Execute executes the request * @return ServiceAccountData

func (*ServiceAccountsApiService) UpdateServiceAccount

* UpdateServiceAccount Update service account * Update a service account by id. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param id * @return ApiUpdateServiceAccountRequest

func (*ServiceAccountsApiService) UpdateServiceAccountExecute

* Execute executes the request * @return ServiceAccountData

type ValidationExceptionData added in v0.5.0

type ValidationExceptionData struct {
	Fields           *map[string]string `json:"fields,omitempty"`
	Error            *string            `json:"error,omitempty"`
	ErrorDescription *string            `json:"error_description,omitempty"`
}

ValidationExceptionData struct for ValidationExceptionData

func NewValidationExceptionData added in v0.5.0

func NewValidationExceptionData() *ValidationExceptionData

NewValidationExceptionData instantiates a new ValidationExceptionData 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 NewValidationExceptionDataWithDefaults added in v0.5.0

func NewValidationExceptionDataWithDefaults() *ValidationExceptionData

NewValidationExceptionDataWithDefaults instantiates a new ValidationExceptionData 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 (*ValidationExceptionData) GetError added in v0.5.0

func (o *ValidationExceptionData) GetError() string

GetError returns the Error field value if set, zero value otherwise.

func (*ValidationExceptionData) GetErrorDescription added in v0.5.0

func (o *ValidationExceptionData) GetErrorDescription() string

GetErrorDescription returns the ErrorDescription field value if set, zero value otherwise.

func (*ValidationExceptionData) GetErrorDescriptionOk added in v0.5.0

func (o *ValidationExceptionData) GetErrorDescriptionOk() (*string, bool)

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

func (*ValidationExceptionData) GetErrorOk added in v0.5.0

func (o *ValidationExceptionData) GetErrorOk() (*string, bool)

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

func (*ValidationExceptionData) GetFields added in v0.5.0

func (o *ValidationExceptionData) GetFields() map[string]string

GetFields returns the Fields field value if set, zero value otherwise.

func (*ValidationExceptionData) GetFieldsOk added in v0.5.0

func (o *ValidationExceptionData) GetFieldsOk() (*map[string]string, bool)

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

func (*ValidationExceptionData) HasError added in v0.5.0

func (o *ValidationExceptionData) HasError() bool

HasError returns a boolean if a field has been set.

func (*ValidationExceptionData) HasErrorDescription added in v0.5.0

func (o *ValidationExceptionData) HasErrorDescription() bool

HasErrorDescription returns a boolean if a field has been set.

func (*ValidationExceptionData) HasFields added in v0.5.0

func (o *ValidationExceptionData) HasFields() bool

HasFields returns a boolean if a field has been set.

func (ValidationExceptionData) MarshalJSON added in v0.5.0

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

func (*ValidationExceptionData) SetError added in v0.5.0

func (o *ValidationExceptionData) SetError(v string)

SetError gets a reference to the given string and assigns it to the Error field.

func (*ValidationExceptionData) SetErrorDescription added in v0.5.0

func (o *ValidationExceptionData) SetErrorDescription(v string)

SetErrorDescription gets a reference to the given string and assigns it to the ErrorDescription field.

func (*ValidationExceptionData) SetFields added in v0.5.0

func (o *ValidationExceptionData) SetFields(v map[string]string)

SetFields gets a reference to the given map[string]string and assigns it to the Fields field.

Jump to

Keyboard shortcuts

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