ccresourcelocations

package
v0.4.2 Latest Latest
Warning

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

Go to latest
Published: Jun 12, 2024 License: Apache-2.0 Imports: 20 Imported by: 0

README

Go API client for ccresourcelocations

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

Overview

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

  • API version: v1
  • Package version: 1.0.0
  • Generator version: 7.5.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/net/context

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

import ccresourcelocations "github.com/citrix/citrix-daas-rest-go/ccresourcelocations"

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 ccresourcelocations.ContextServerIndex of type int.

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

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

ctx := context.WithValue(context.Background(), ccresourcelocations.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 ccresourcelocations.ContextOperationServerIndices and ccresourcelocations.ContextOperationServerVariables context maps.

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

Documentation for API Endpoints

All URIs are relative to https://api.cloud.com/resourcelocations

Class Method HTTP request Description
LocationsDAAS LocationsCreate Post / Create a resource location for a customer.
LocationsDAAS LocationsDelete Delete /{Id} Delete a resource location.
LocationsDAAS LocationsGet Get /{Id} Get a resource location from id.
LocationsDAAS LocationsGetAll Get / Get all resource locations for a customer.
LocationsDAAS LocationsUpdate Put /{Id} Update the customer resource location information.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

CWSAuth
  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		ccresourcelocations.ContextAPIKeys,
		map[string]ccresourcelocations.APIKey{
			"Authorization": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)
Basic
  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), ccresourcelocations.ContextBasicAuth, ccresourcelocations.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

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	JsonCheck = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?json)`)
	XmlCheck  = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?xml)`)
)
View Source
var (
	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

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

	// 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 IsNil

func IsNil(i interface{}) bool

IsNil checks if an input is nil

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

APIClient manages communication with the Resource Locations APIs API vv1 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 ApiLocationsCreateRequest

type ApiLocationsCreateRequest struct {
	ApiService *LocationsDAASService
	// contains filtered or unexported fields
}

func (ApiLocationsCreateRequest) Accept

Only supports application/json

func (ApiLocationsCreateRequest) Authorization

func (r ApiLocationsCreateRequest) Authorization(authorization string) ApiLocationsCreateRequest

The access token.

func (ApiLocationsCreateRequest) CitrixCustomerId

func (r ApiLocationsCreateRequest) CitrixCustomerId(citrixCustomerId string) ApiLocationsCreateRequest

ID of the customer.

func (ApiLocationsCreateRequest) Model

The resource location model.

type ApiLocationsDeleteRequest

type ApiLocationsDeleteRequest struct {
	ApiService *LocationsDAASService
	// contains filtered or unexported fields
}

func (ApiLocationsDeleteRequest) Accept

Only supports application/json

func (ApiLocationsDeleteRequest) Authorization

func (r ApiLocationsDeleteRequest) Authorization(authorization string) ApiLocationsDeleteRequest

The access token.

func (ApiLocationsDeleteRequest) CitrixCustomerId

func (r ApiLocationsDeleteRequest) CitrixCustomerId(citrixCustomerId string) ApiLocationsDeleteRequest

ID of the customer.

func (ApiLocationsDeleteRequest) Execute

func (r ApiLocationsDeleteRequest) Execute() (*http.Response, error)

type ApiLocationsGetAllRequest

type ApiLocationsGetAllRequest struct {
	ApiService *LocationsDAASService
	// contains filtered or unexported fields
}

func (ApiLocationsGetAllRequest) Accept

Only supports application/json

func (ApiLocationsGetAllRequest) Authorization

func (r ApiLocationsGetAllRequest) Authorization(authorization string) ApiLocationsGetAllRequest

The access token.

func (ApiLocationsGetAllRequest) CitrixCustomerId

func (r ApiLocationsGetAllRequest) CitrixCustomerId(citrixCustomerId string) ApiLocationsGetAllRequest

ID of the customer.

type ApiLocationsGetRequest

type ApiLocationsGetRequest struct {
	ApiService *LocationsDAASService
	// contains filtered or unexported fields
}

func (ApiLocationsGetRequest) Accept

Only supports application/json

func (ApiLocationsGetRequest) Authorization

func (r ApiLocationsGetRequest) Authorization(authorization string) ApiLocationsGetRequest

The access token.

func (ApiLocationsGetRequest) CitrixCustomerId

func (r ApiLocationsGetRequest) CitrixCustomerId(citrixCustomerId string) ApiLocationsGetRequest

ID of the customer.

type ApiLocationsUpdateRequest

type ApiLocationsUpdateRequest struct {
	ApiService *LocationsDAASService
	// contains filtered or unexported fields
}

func (ApiLocationsUpdateRequest) Accept

Only supports application/json

func (ApiLocationsUpdateRequest) Authorization

func (r ApiLocationsUpdateRequest) Authorization(authorization string) ApiLocationsUpdateRequest

The access token.

func (ApiLocationsUpdateRequest) CitrixCustomerId

func (r ApiLocationsUpdateRequest) CitrixCustomerId(citrixCustomerId string) ApiLocationsUpdateRequest

ID of the customer.

func (ApiLocationsUpdateRequest) Model

The resource location model.

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 CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel

type CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel struct {
	// Id used for API calls regarding resource location.
	Id *string `json:"id,omitempty"`
	// Resource Location Name
	Name string `json:"name"`
	// Resource Location Connectivity
	InternalOnly *bool `json:"internalOnly,omitempty"`
	// Time zone.
	TimeZone *string `json:"timeZone,omitempty"`
	// If true means the resource location is managed by citrix.
	ReadOnly *bool `json:"readOnly,omitempty"`
}

CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel

func NewCitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel

func NewCitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel(name string) *CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel

NewCitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel instantiates a new CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel 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 NewCitrixCloudServicesRegistryApiModelsLocationsResourceLocationModelWithDefaults

func NewCitrixCloudServicesRegistryApiModelsLocationsResourceLocationModelWithDefaults() *CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel

NewCitrixCloudServicesRegistryApiModelsLocationsResourceLocationModelWithDefaults instantiates a new CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel 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 (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) GetId

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

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) GetIdOk

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 (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) GetInternalOnly

GetInternalOnly returns the InternalOnly field value if set, zero value otherwise.

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) GetInternalOnlyOk

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

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) GetName

GetName returns the Name field value

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) GetNameOk

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

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) GetReadOnly

GetReadOnly returns the ReadOnly field value if set, zero value otherwise.

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) GetReadOnlyOk

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

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) GetTimeZone

GetTimeZone returns the TimeZone field value if set, zero value otherwise.

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) GetTimeZoneOk

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

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) HasId

HasId returns a boolean if a field has been set.

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) HasInternalOnly

HasInternalOnly returns a boolean if a field has been set.

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) HasReadOnly

HasReadOnly returns a boolean if a field has been set.

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) HasTimeZone

HasTimeZone returns a boolean if a field has been set.

func (CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) MarshalJSON

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) SetId

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

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) SetInternalOnly

SetInternalOnly gets a reference to the given bool and assigns it to the InternalOnly field.

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) SetName

SetName sets field value

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) SetReadOnly

SetReadOnly gets a reference to the given bool and assigns it to the ReadOnly field.

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) SetTimeZone

SetTimeZone gets a reference to the given string and assigns it to the TimeZone field.

func (CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) ToMap

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) UnmarshalJSON

type CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel

type CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel struct {
	// The new Resource Location Name.
	Name *string `json:"name,omitempty"`
	// Resource Location Connectivity
	InternalOnly *bool `json:"internalOnly,omitempty"`
	// Time zone.
	TimeZone *string `json:"timeZone,omitempty"`
	// If true means the resource location is managed by citrix.
	ReadOnly *bool `json:"readOnly,omitempty"`
}

CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel Information used to update a customer resource location.

func NewCitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel

func NewCitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel() *CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel

NewCitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel instantiates a new CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel 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 NewCitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModelWithDefaults

func NewCitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModelWithDefaults() *CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel

NewCitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModelWithDefaults instantiates a new CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel 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 (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) GetInternalOnly

GetInternalOnly returns the InternalOnly field value if set, zero value otherwise.

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) GetInternalOnlyOk

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

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) GetName

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

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) GetNameOk

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 (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) GetReadOnly

GetReadOnly returns the ReadOnly field value if set, zero value otherwise.

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) GetReadOnlyOk

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

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) GetTimeZone

GetTimeZone returns the TimeZone field value if set, zero value otherwise.

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) GetTimeZoneOk

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

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) HasInternalOnly

HasInternalOnly returns a boolean if a field has been set.

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) HasName

HasName returns a boolean if a field has been set.

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) HasReadOnly

HasReadOnly returns a boolean if a field has been set.

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) HasTimeZone

HasTimeZone returns a boolean if a field has been set.

func (CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) MarshalJSON

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) SetInternalOnly

SetInternalOnly gets a reference to the given bool and assigns it to the InternalOnly field.

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) SetName

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

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) SetReadOnly

SetReadOnly gets a reference to the given bool and assigns it to the ReadOnly field.

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) SetTimeZone

SetTimeZone gets a reference to the given string and assigns it to the TimeZone field.

func (CitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) ToMap

type CitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel

type CitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel struct {
	// A list of resource locations.
	Items []CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel `json:"items,omitempty"`
}

CitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel

func NewCitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel

func NewCitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel() *CitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel

NewCitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel instantiates a new CitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel 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 NewCitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModelWithDefaults

func NewCitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModelWithDefaults() *CitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel

NewCitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModelWithDefaults instantiates a new CitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel 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 (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel) GetItems

GetItems returns the Items field value if set, zero value otherwise.

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel) GetItemsOk

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

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel) HasItems

HasItems returns a boolean if a field has been set.

func (CitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel) MarshalJSON

func (*CitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel) SetItems

SetItems gets a reference to the given []CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel and assigns it to the Items field.

func (CitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel) ToMap

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
	Middleware          MiddlewareFunction
	MiddlewareWithError MiddlewareFunctionWithError
	ResponseMiddleware  ResponseMiddlewareFunction
}

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

type LocationsDAASService service

LocationsDAASService LocationsDAAS service

func (*LocationsDAASService) LocationsCreate

LocationsCreate Create a resource location for a customer.

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

func (*LocationsDAASService) LocationsCreateExecute

Execute executes the request

@return CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel

func (*LocationsDAASService) LocationsDelete

LocationsDelete Delete a resource location.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The resource location id.
@return ApiLocationsDeleteRequest

func (*LocationsDAASService) LocationsDeleteExecute

func (a *LocationsDAASService) LocationsDeleteExecute(r ApiLocationsDeleteRequest) (*http.Response, error)

Execute executes the request

func (*LocationsDAASService) LocationsGet

LocationsGet Get a resource location from id.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The resource location id
@return ApiLocationsGetRequest

func (*LocationsDAASService) LocationsGetAll

LocationsGetAll Get all resource locations for a customer.

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

func (*LocationsDAASService) LocationsGetAllExecute

Execute executes the request

@return CitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel

func (*LocationsDAASService) LocationsGetExecute

Execute executes the request

@return CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel

func (*LocationsDAASService) LocationsUpdate

LocationsUpdate Update the customer resource location information.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The resource location id.
@return ApiLocationsUpdateRequest

func (*LocationsDAASService) LocationsUpdateExecute

Execute executes the request

@return CitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel

type MappedNullable

type MappedNullable interface {
	ToMap() (map[string]interface{}, error)
}

type MiddlewareFunction

type MiddlewareFunction func(*http.Request)

MiddlewareFunction provides way to implement custom middleware in the prepareRequest

type MiddlewareFunctionWithError

type MiddlewareFunctionWithError func(*http.Request) error

MiddlewareFunctionWithError provides way to implement custom middleware with errors in the prepareRequest

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 NullableCitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel

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

func (NullableCitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) Get

func (NullableCitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) IsSet

func (NullableCitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) MarshalJSON

func (*NullableCitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) Set

func (*NullableCitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) UnmarshalJSON

func (*NullableCitrixCloudServicesRegistryApiModelsLocationsResourceLocationModel) Unset

type NullableCitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel

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

func (NullableCitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) Get

func (NullableCitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) IsSet

func (NullableCitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) MarshalJSON

func (*NullableCitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) Set

func (*NullableCitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) UnmarshalJSON

func (*NullableCitrixCloudServicesRegistryApiModelsLocationsResourceLocationUpdateModel) Unset

type NullableCitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel

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

func (NullableCitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel) Get

func (NullableCitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel) IsSet

func (NullableCitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel) MarshalJSON

func (*NullableCitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel) Set

func (*NullableCitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel) UnmarshalJSON

func (*NullableCitrixCloudServicesRegistryApiModelsLocationsResourceLocationsResultsModel) 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 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 ResponseMiddlewareFunction

type ResponseMiddlewareFunction func(*http.Response, []byte) error

ResponseMiddlewareFunction provides way to implement custom middleware with errors after the response is received

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

Jump to

Keyboard shortcuts

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