apigatewaycontrollerapiv1

package
v0.0.0-...-a5d5d49 Latest Latest
Warning

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

Go to latest
Published: Jul 14, 2021 License: Apache-2.0 Imports: 3 Imported by: 2

Documentation

Overview

Package apigatewaycontrollerapiv1 : Operations and models for the ApiGatewayControllerApiV1 service

Index

Constants

View Source
const (
	GetEndpointSwaggerOptions_Type_JSON = "json"
	GetEndpointSwaggerOptions_Type_Yaml = "yaml"
)

Constants associated with the GetEndpointSwaggerOptions.Type property. Type of swagger to retrieve.

View Source
const DefaultServiceName = "api_gateway_controller_api"

DefaultServiceName is the default key used to find external configuration information.

View Source
const DefaultServiceURL = "https://api.us-south.apigw.cloud.ibm.com/controller"

DefaultServiceURL is the default URL to make service requests to.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddSubscriptionSecretOptions

type AddSubscriptionSecretOptions struct {
	// Client Id.
	ID *string `json:"id" validate:"required"`

	// Artifact Id.
	ArtifactID *string `json:"artifact_id" validate:"required"`

	// Client id.
	Authorization *string `json:"authorization" validate:"required"`

	ClientSecret *string `json:"client_secret,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

AddSubscriptionSecretOptions : The AddSubscriptionSecret options.

func (*AddSubscriptionSecretOptions) SetArtifactID

func (options *AddSubscriptionSecretOptions) SetArtifactID(artifactID string) *AddSubscriptionSecretOptions

SetArtifactID : Allow user to set ArtifactID

func (*AddSubscriptionSecretOptions) SetAuthorization

func (options *AddSubscriptionSecretOptions) SetAuthorization(authorization string) *AddSubscriptionSecretOptions

SetAuthorization : Allow user to set Authorization

func (*AddSubscriptionSecretOptions) SetClientSecret

func (options *AddSubscriptionSecretOptions) SetClientSecret(clientSecret string) *AddSubscriptionSecretOptions

SetClientSecret : Allow user to set ClientSecret

func (*AddSubscriptionSecretOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*AddSubscriptionSecretOptions) SetID

SetID : Allow user to set ID

type ApiGatewayControllerApiV1

type ApiGatewayControllerApiV1 struct {
	Service *core.BaseService
}

ApiGatewayControllerApiV1 : Primary REST API for creating and managing APIs within the IBM Cloud API Gateway service.

Version: 1.0.0

func NewApiGatewayControllerApiV1

func NewApiGatewayControllerApiV1(options *ApiGatewayControllerApiV1Options) (service *ApiGatewayControllerApiV1, err error)

NewApiGatewayControllerApiV1 : constructs an instance of ApiGatewayControllerApiV1 with passed in options.

func NewApiGatewayControllerApiV1UsingExternalConfig

func NewApiGatewayControllerApiV1UsingExternalConfig(options *ApiGatewayControllerApiV1Options) (apiGatewayControllerApi *ApiGatewayControllerApiV1, err error)

NewApiGatewayControllerApiV1UsingExternalConfig : constructs an instance of ApiGatewayControllerApiV1 with passed in options and external configuration.

func (*ApiGatewayControllerApiV1) AddSubscriptionSecret

func (apiGatewayControllerApi *ApiGatewayControllerApiV1) AddSubscriptionSecret(addSubscriptionSecretOptions *AddSubscriptionSecretOptions) (result *V2Subscription, response *core.DetailedResponse, err error)

AddSubscriptionSecret : Add a Subscription Secret

func (*ApiGatewayControllerApiV1) CreateEndpoint

func (apiGatewayControllerApi *ApiGatewayControllerApiV1) CreateEndpoint(createEndpointOptions *CreateEndpointOptions) (result *V2Endpoint, response *core.DetailedResponse, err error)

CreateEndpoint : Create an Endpoint

func (*ApiGatewayControllerApiV1) CreateSubscription

func (apiGatewayControllerApi *ApiGatewayControllerApiV1) CreateSubscription(createSubscriptionOptions *CreateSubscriptionOptions) (result *V2Subscription, response *core.DetailedResponse, err error)

CreateSubscription : Create a subscription for an artifact

func (*ApiGatewayControllerApiV1) DeleteEndpoint

func (apiGatewayControllerApi *ApiGatewayControllerApiV1) DeleteEndpoint(deleteEndpointOptions *DeleteEndpointOptions) (response *core.DetailedResponse, err error)

DeleteEndpoint : Delete an Endpoint

func (*ApiGatewayControllerApiV1) DeleteSubscription

func (apiGatewayControllerApi *ApiGatewayControllerApiV1) DeleteSubscription(deleteSubscriptionOptions *DeleteSubscriptionOptions) (response *core.DetailedResponse, err error)

DeleteSubscription : Delete a subscription

func (*ApiGatewayControllerApiV1) EndpointActions

func (apiGatewayControllerApi *ApiGatewayControllerApiV1) EndpointActions(endpointActionsOptions *EndpointActionsOptions) (result *V2Endpoint, response *core.DetailedResponse, err error)

EndpointActions : Execute actions for a given Endpoint

func (*ApiGatewayControllerApiV1) EndpointSummary

func (apiGatewayControllerApi *ApiGatewayControllerApiV1) EndpointSummary(endpointSummaryOptions *EndpointSummaryOptions) (result *[]V2EndpointSummary, response *core.DetailedResponse, err error)

EndpointSummary : Get provider sorted summary about all Endpoints

func (*ApiGatewayControllerApiV1) GetAllEndpoints

func (apiGatewayControllerApi *ApiGatewayControllerApiV1) GetAllEndpoints(getAllEndpointsOptions *GetAllEndpointsOptions) (result *[]V2Endpoint, response *core.DetailedResponse, err error)

GetAllEndpoints : Get details for all Endpoints

func (*ApiGatewayControllerApiV1) GetAllSubscriptions

func (apiGatewayControllerApi *ApiGatewayControllerApiV1) GetAllSubscriptions(getAllSubscriptionsOptions *GetAllSubscriptionsOptions) (result *[]V2Subscription, response *core.DetailedResponse, err error)

GetAllSubscriptions : Get all subscriptions tied to a given artifact

func (*ApiGatewayControllerApiV1) GetEndpoint

func (apiGatewayControllerApi *ApiGatewayControllerApiV1) GetEndpoint(getEndpointOptions *GetEndpointOptions) (result *V2Endpoint, response *core.DetailedResponse, err error)

GetEndpoint : Get details for a given Endpoint

func (*ApiGatewayControllerApiV1) GetEndpointSwagger

func (apiGatewayControllerApi *ApiGatewayControllerApiV1) GetEndpointSwagger(getEndpointSwaggerOptions *GetEndpointSwaggerOptions) (response *core.DetailedResponse, err error)

GetEndpointSwagger : Get the OpenAPI doc for a given Endpoint

func (*ApiGatewayControllerApiV1) GetSubscription

func (apiGatewayControllerApi *ApiGatewayControllerApiV1) GetSubscription(getSubscriptionOptions *GetSubscriptionOptions) (result *V2Subscription, response *core.DetailedResponse, err error)

GetSubscription : Get subscription for a given clientid

func (*ApiGatewayControllerApiV1) GetSubscriptionArtifact

func (apiGatewayControllerApi *ApiGatewayControllerApiV1) GetSubscriptionArtifact(getSubscriptionArtifactOptions *GetSubscriptionArtifactOptions) (result *InlineResponse200, response *core.DetailedResponse, err error)

GetSubscriptionArtifact : Get artifact associated to a subscription

func (*ApiGatewayControllerApiV1) NewAddSubscriptionSecretOptions

func (*ApiGatewayControllerApiV1) NewAddSubscriptionSecretOptions(id string, artifactID string, authorization string) *AddSubscriptionSecretOptions

NewAddSubscriptionSecretOptions : Instantiate AddSubscriptionSecretOptions

func (*ApiGatewayControllerApiV1) NewCreateEndpointOptions

func (*ApiGatewayControllerApiV1) NewCreateEndpointOptions(authorization string, artifactID string, parentCrn string, serviceInstanceCrn string) *CreateEndpointOptions

NewCreateEndpointOptions : Instantiate CreateEndpointOptions

func (*ApiGatewayControllerApiV1) NewCreateSubscriptionOptions

func (*ApiGatewayControllerApiV1) NewCreateSubscriptionOptions(authorization string, clientID string, artifactID string) *CreateSubscriptionOptions

NewCreateSubscriptionOptions : Instantiate CreateSubscriptionOptions

func (*ApiGatewayControllerApiV1) NewDeleteEndpointOptions

func (*ApiGatewayControllerApiV1) NewDeleteEndpointOptions(id string, serviceInstanceCrn string, authorization string) *DeleteEndpointOptions

NewDeleteEndpointOptions : Instantiate DeleteEndpointOptions

func (*ApiGatewayControllerApiV1) NewDeleteSubscriptionOptions

func (*ApiGatewayControllerApiV1) NewDeleteSubscriptionOptions(id string, artifactID string, authorization string) *DeleteSubscriptionOptions

NewDeleteSubscriptionOptions : Instantiate DeleteSubscriptionOptions

func (*ApiGatewayControllerApiV1) NewEndpointActionsOptions

func (*ApiGatewayControllerApiV1) NewEndpointActionsOptions(id string, serviceInstanceCrn string, providerID string, authorization string, typeVar string) *EndpointActionsOptions

NewEndpointActionsOptions : Instantiate EndpointActionsOptions

func (*ApiGatewayControllerApiV1) NewEndpointSummaryOptions

func (*ApiGatewayControllerApiV1) NewEndpointSummaryOptions(accountID string, authorization string) *EndpointSummaryOptions

NewEndpointSummaryOptions : Instantiate EndpointSummaryOptions

func (*ApiGatewayControllerApiV1) NewGetAllEndpointsOptions

func (*ApiGatewayControllerApiV1) NewGetAllEndpointsOptions(serviceInstanceCrn string, authorization string) *GetAllEndpointsOptions

NewGetAllEndpointsOptions : Instantiate GetAllEndpointsOptions

func (*ApiGatewayControllerApiV1) NewGetAllSubscriptionsOptions

func (*ApiGatewayControllerApiV1) NewGetAllSubscriptionsOptions(artifactID string, authorization string) *GetAllSubscriptionsOptions

NewGetAllSubscriptionsOptions : Instantiate GetAllSubscriptionsOptions

func (*ApiGatewayControllerApiV1) NewGetEndpointOptions

func (*ApiGatewayControllerApiV1) NewGetEndpointOptions(id string, serviceInstanceCrn string, authorization string) *GetEndpointOptions

NewGetEndpointOptions : Instantiate GetEndpointOptions

func (*ApiGatewayControllerApiV1) NewGetEndpointSwaggerOptions

func (*ApiGatewayControllerApiV1) NewGetEndpointSwaggerOptions(id string, serviceInstanceCrn string, authorization string) *GetEndpointSwaggerOptions

NewGetEndpointSwaggerOptions : Instantiate GetEndpointSwaggerOptions

func (*ApiGatewayControllerApiV1) NewGetSubscriptionArtifactOptions

func (*ApiGatewayControllerApiV1) NewGetSubscriptionArtifactOptions(artifactID string) *GetSubscriptionArtifactOptions

NewGetSubscriptionArtifactOptions : Instantiate GetSubscriptionArtifactOptions

func (*ApiGatewayControllerApiV1) NewGetSubscriptionOptions

func (*ApiGatewayControllerApiV1) NewGetSubscriptionOptions(id string, artifactID string, authorization string) *GetSubscriptionOptions

NewGetSubscriptionOptions : Instantiate GetSubscriptionOptions

func (*ApiGatewayControllerApiV1) NewUpdateEndpointOptions

func (*ApiGatewayControllerApiV1) NewUpdateEndpointOptions(id string, serviceInstanceCrn string, authorization string, newArtifactID string, newParentCrn string, newServiceInstanceCrn string) *UpdateEndpointOptions

NewUpdateEndpointOptions : Instantiate UpdateEndpointOptions

func (*ApiGatewayControllerApiV1) NewUpdateSubscriptionOptions

func (*ApiGatewayControllerApiV1) NewUpdateSubscriptionOptions(id string, artifactID string, authorization string) *UpdateSubscriptionOptions

NewUpdateSubscriptionOptions : Instantiate UpdateSubscriptionOptions

func (*ApiGatewayControllerApiV1) SetServiceURL

func (apiGatewayControllerApi *ApiGatewayControllerApiV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*ApiGatewayControllerApiV1) UpdateEndpoint

func (apiGatewayControllerApi *ApiGatewayControllerApiV1) UpdateEndpoint(updateEndpointOptions *UpdateEndpointOptions) (result *V2Endpoint, response *core.DetailedResponse, err error)

UpdateEndpoint : Update an endpoint

func (*ApiGatewayControllerApiV1) UpdateSubscription

func (apiGatewayControllerApi *ApiGatewayControllerApiV1) UpdateSubscription(updateSubscriptionOptions *UpdateSubscriptionOptions) (result *V2Subscription, response *core.DetailedResponse, err error)

UpdateSubscription : Update a subscription

type ApiGatewayControllerApiV1Options

type ApiGatewayControllerApiV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

ApiGatewayControllerApiV1Options : Service options

type CreateEndpointOptions

type CreateEndpointOptions struct {
	// User IAM token.
	Authorization *string `json:"authorization" validate:"required"`

	// The endpoint ID.
	ArtifactID *string `json:"artifact_id",omitempt`

	// The API Gateway service instance CRN.
	ParentCrn *string `json:"parent_crn" validate:"required"`

	// The API Gateway service instance CRN.
	ServiceInstanceCrn *string `json:"service_instance_crn" validate:"required"`

	// The endpoint's name.
	Name *string `json:"name validate:"required"`

	// Invokable endpoint routes.
	Routes []string `json:"routes,omitempty"`

	// Is the endpoint managed?.
	Managed *bool `json:"managed,omitempty"`

	Metadata interface{} `json:"metadata,omitempty"`

	// The OpenAPI document.
	OpenApiDoc interface{} `json:"open_api_doc validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateEndpointOptions : The CreateEndpoint options.

func (*CreateEndpointOptions) SetArtifactID

func (options *CreateEndpointOptions) SetArtifactID(artifactID string) *CreateEndpointOptions

SetArtifactID : Allow user to set ArtifactID

func (*CreateEndpointOptions) SetAuthorization

func (options *CreateEndpointOptions) SetAuthorization(authorization string) *CreateEndpointOptions

SetAuthorization : Allow user to set Authorization

func (*CreateEndpointOptions) SetHeaders

func (options *CreateEndpointOptions) SetHeaders(param map[string]string) *CreateEndpointOptions

SetHeaders : Allow user to set Headers

func (*CreateEndpointOptions) SetManaged

func (options *CreateEndpointOptions) SetManaged(managed bool) *CreateEndpointOptions

SetManaged : Allow user to set Managed

func (*CreateEndpointOptions) SetMetadata

func (options *CreateEndpointOptions) SetMetadata(metadata interface{}) *CreateEndpointOptions

SetMetadata : Allow user to set Metadata

func (*CreateEndpointOptions) SetName

func (options *CreateEndpointOptions) SetName(name string) *CreateEndpointOptions

SetName : Allow user to set Name

func (*CreateEndpointOptions) SetOpenApiDoc

func (options *CreateEndpointOptions) SetOpenApiDoc(openApiDoc interface{}) *CreateEndpointOptions

SetOpenApiDoc : Allow user to set OpenApiDoc

func (*CreateEndpointOptions) SetParentCrn

func (options *CreateEndpointOptions) SetParentCrn(parentCrn string) *CreateEndpointOptions

SetParentCrn : Allow user to set ParentCrn

func (*CreateEndpointOptions) SetRoutes

func (options *CreateEndpointOptions) SetRoutes(routes []string) *CreateEndpointOptions

SetRoutes : Allow user to set Routes

func (*CreateEndpointOptions) SetServiceInstanceCrn

func (options *CreateEndpointOptions) SetServiceInstanceCrn(serviceInstanceCrn string) *CreateEndpointOptions

SetServiceInstanceCrn : Allow user to set ServiceInstanceCrn

type CreateSubscriptionOptions

type CreateSubscriptionOptions struct {
	// User bearer token.
	Authorization *string `json:"authorization" validate:"required"`

	ClientID *string `json:"client_id",omitempty`

	ArtifactID *string `json:"artifact_id" validate:"required"`

	ClientSecret *string `json:"client_secret,omitempty"`

	GenerateSecret *bool `json:"generate_secret, omitempty"`

	AccountID *string `json:"account_id,omitempty"`

	Name *string `json:"name,omitempty"`

	Type *string `json:"type,omitempty"`

	Metadata interface{} `json:"metadata,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateSubscriptionOptions : The CreateSubscription options.

func (*CreateSubscriptionOptions) SetAccountID

func (options *CreateSubscriptionOptions) SetAccountID(accountID string) *CreateSubscriptionOptions

SetAccountID : Allow user to set AccountID

func (*CreateSubscriptionOptions) SetArtifactID

func (options *CreateSubscriptionOptions) SetArtifactID(artifactID string) *CreateSubscriptionOptions

SetArtifactID : Allow user to set ArtifactID

func (*CreateSubscriptionOptions) SetAuthorization

func (options *CreateSubscriptionOptions) SetAuthorization(authorization string) *CreateSubscriptionOptions

SetAuthorization : Allow user to set Authorization

func (*CreateSubscriptionOptions) SetClientID

func (options *CreateSubscriptionOptions) SetClientID(clientID string) *CreateSubscriptionOptions

SetClientID : Allow user to set ClientID

func (*CreateSubscriptionOptions) SetClientSecret

func (options *CreateSubscriptionOptions) SetClientSecret(clientSecret string) *CreateSubscriptionOptions

SetClientSecret : Allow user to set ClientSecret

func (*CreateSubscriptionOptions) SetHeaders

func (options *CreateSubscriptionOptions) SetHeaders(param map[string]string) *CreateSubscriptionOptions

SetHeaders : Allow user to set Headers

func (*CreateSubscriptionOptions) SetMetadata

func (options *CreateSubscriptionOptions) SetMetadata(metadata interface{}) *CreateSubscriptionOptions

SetMetadata : Allow user to set Metadata

func (*CreateSubscriptionOptions) SetName

SetName : Allow user to set Name

func (*CreateSubscriptionOptions) SetType

func (options *CreateSubscriptionOptions) SetType(typeVar string) *CreateSubscriptionOptions

SetType : Allow user to set Type

type DeleteEndpointOptions

type DeleteEndpointOptions struct {
	// Endpoint id.
	ID *string `json:"id" validate:"required"`

	// Service Instance CRN.
	ServiceInstanceCrn *string `json:"service_instance_crn" validate:"required"`

	// User IAM token.
	Authorization *string `json:"authorization" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteEndpointOptions : The DeleteEndpoint options.

func (*DeleteEndpointOptions) SetAuthorization

func (options *DeleteEndpointOptions) SetAuthorization(authorization string) *DeleteEndpointOptions

SetAuthorization : Allow user to set Authorization

func (*DeleteEndpointOptions) SetHeaders

func (options *DeleteEndpointOptions) SetHeaders(param map[string]string) *DeleteEndpointOptions

SetHeaders : Allow user to set Headers

func (*DeleteEndpointOptions) SetID

SetID : Allow user to set ID

func (*DeleteEndpointOptions) SetServiceInstanceCrn

func (options *DeleteEndpointOptions) SetServiceInstanceCrn(serviceInstanceCrn string) *DeleteEndpointOptions

SetServiceInstanceCrn : Allow user to set ServiceInstanceCrn

type DeleteSubscriptionOptions

type DeleteSubscriptionOptions struct {
	// Client Id.
	ID *string `json:"id" validate:"required"`

	// Artifact Id.
	ArtifactID *string `json:"artifact_id" validate:"required"`

	// User bearer token.
	Authorization *string `json:"authorization" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteSubscriptionOptions : The DeleteSubscription options.

func (*DeleteSubscriptionOptions) SetArtifactID

func (options *DeleteSubscriptionOptions) SetArtifactID(artifactID string) *DeleteSubscriptionOptions

SetArtifactID : Allow user to set ArtifactID

func (*DeleteSubscriptionOptions) SetAuthorization

func (options *DeleteSubscriptionOptions) SetAuthorization(authorization string) *DeleteSubscriptionOptions

SetAuthorization : Allow user to set Authorization

func (*DeleteSubscriptionOptions) SetHeaders

func (options *DeleteSubscriptionOptions) SetHeaders(param map[string]string) *DeleteSubscriptionOptions

SetHeaders : Allow user to set Headers

func (*DeleteSubscriptionOptions) SetID

SetID : Allow user to set ID

type EndpointActionsOptions

type EndpointActionsOptions struct {
	// Endpoint Id.
	ID *string `json:"id" validate:"required"`

	// Service Instance CRN.
	ServiceInstanceCrn *string `json:"service_instance_crn" validate:"required"`

	// Provider Id.
	ProviderID *string `json:"provider_id" validate:"required"`

	// User IAM token.
	Authorization *string `json:"authorization" validate:"required"`

	Type *string `json:"type" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

EndpointActionsOptions : The EndpointActions options.

func (*EndpointActionsOptions) SetAuthorization

func (options *EndpointActionsOptions) SetAuthorization(authorization string) *EndpointActionsOptions

SetAuthorization : Allow user to set Authorization

func (*EndpointActionsOptions) SetHeaders

func (options *EndpointActionsOptions) SetHeaders(param map[string]string) *EndpointActionsOptions

SetHeaders : Allow user to set Headers

func (*EndpointActionsOptions) SetID

SetID : Allow user to set ID

func (*EndpointActionsOptions) SetProviderID

func (options *EndpointActionsOptions) SetProviderID(providerID string) *EndpointActionsOptions

SetProviderID : Allow user to set ProviderID

func (*EndpointActionsOptions) SetServiceInstanceCrn

func (options *EndpointActionsOptions) SetServiceInstanceCrn(serviceInstanceCrn string) *EndpointActionsOptions

SetServiceInstanceCrn : Allow user to set ServiceInstanceCrn

func (*EndpointActionsOptions) SetType

func (options *EndpointActionsOptions) SetType(typeVar string) *EndpointActionsOptions

SetType : Allow user to set Type

type EndpointSummaryOptions

type EndpointSummaryOptions struct {
	// User account ID.
	AccountID *string `json:"account_id" validate:"required"`

	// User IAM token.
	Authorization *string `json:"authorization" validate:"required"`

	// Service Instance CRN.
	ServiceInstanceCrn *string `json:"service_instance_crn,omitempty"`

	// Return OpenAPI doc with list results. Possible values are ['provider', 'consumer']. Defaults to 'provider'.
	Swagger *string `json:"swagger,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

EndpointSummaryOptions : The EndpointSummary options.

func (*EndpointSummaryOptions) SetAccountID

func (options *EndpointSummaryOptions) SetAccountID(accountID string) *EndpointSummaryOptions

SetAccountID : Allow user to set AccountID

func (*EndpointSummaryOptions) SetAuthorization

func (options *EndpointSummaryOptions) SetAuthorization(authorization string) *EndpointSummaryOptions

SetAuthorization : Allow user to set Authorization

func (*EndpointSummaryOptions) SetHeaders

func (options *EndpointSummaryOptions) SetHeaders(param map[string]string) *EndpointSummaryOptions

SetHeaders : Allow user to set Headers

func (*EndpointSummaryOptions) SetServiceInstanceCrn

func (options *EndpointSummaryOptions) SetServiceInstanceCrn(serviceInstanceCrn string) *EndpointSummaryOptions

SetServiceInstanceCrn : Allow user to set ServiceInstanceCrn

func (*EndpointSummaryOptions) SetSwagger

func (options *EndpointSummaryOptions) SetSwagger(swagger string) *EndpointSummaryOptions

SetSwagger : Allow user to set Swagger

type GetAllEndpointsOptions

type GetAllEndpointsOptions struct {
	// The API Gateway service instance CRN.
	ServiceInstanceCrn *string `json:"service_instance_crn" validate:"required"`

	// Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam
	// oauth-tokens`.
	Authorization *string `json:"authorization" validate:"required"`

	// Provider Id.
	ProviderID *string `json:"provider_id,omitempty"`

	// Only return shared endpoints.
	Shared *bool `json:"shared,omitempty"`

	// Only return managed endpoints.
	Managed *bool `json:"managed,omitempty"`

	// Return OpenAPI doc with list results. Possible values are ['provider', 'consumer']. Defaults to 'provider'.
	Swagger *string `json:"swagger,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetAllEndpointsOptions : The GetAllEndpoints options.

func (*GetAllEndpointsOptions) SetAuthorization

func (options *GetAllEndpointsOptions) SetAuthorization(authorization string) *GetAllEndpointsOptions

SetAuthorization : Allow user to set Authorization

func (*GetAllEndpointsOptions) SetHeaders

func (options *GetAllEndpointsOptions) SetHeaders(param map[string]string) *GetAllEndpointsOptions

SetHeaders : Allow user to set Headers

func (*GetAllEndpointsOptions) SetManaged

func (options *GetAllEndpointsOptions) SetManaged(managed bool) *GetAllEndpointsOptions

SetManaged : Allow user to set Managed

func (*GetAllEndpointsOptions) SetProviderID

func (options *GetAllEndpointsOptions) SetProviderID(providerID string) *GetAllEndpointsOptions

SetProviderID : Allow user to set ProviderID

func (*GetAllEndpointsOptions) SetServiceInstanceCrn

func (options *GetAllEndpointsOptions) SetServiceInstanceCrn(serviceInstanceCrn string) *GetAllEndpointsOptions

SetServiceInstanceCrn : Allow user to set ServiceInstanceCrn

func (*GetAllEndpointsOptions) SetShared

func (options *GetAllEndpointsOptions) SetShared(shared bool) *GetAllEndpointsOptions

SetShared : Allow user to set Shared

func (*GetAllEndpointsOptions) SetSwagger

func (options *GetAllEndpointsOptions) SetSwagger(swagger string) *GetAllEndpointsOptions

SetSwagger : Allow user to set Swagger

type GetAllSubscriptionsOptions

type GetAllSubscriptionsOptions struct {
	// Artifact Id.
	ArtifactID *string `json:"artifact_id" validate:"required"`

	// User bearer token.
	Authorization *string `json:"authorization" validate:"required"`

	// Subscription type.
	Type *string `json:"type,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetAllSubscriptionsOptions : The GetAllSubscriptions options.

func (*GetAllSubscriptionsOptions) SetArtifactID

func (options *GetAllSubscriptionsOptions) SetArtifactID(artifactID string) *GetAllSubscriptionsOptions

SetArtifactID : Allow user to set ArtifactID

func (*GetAllSubscriptionsOptions) SetAuthorization

func (options *GetAllSubscriptionsOptions) SetAuthorization(authorization string) *GetAllSubscriptionsOptions

SetAuthorization : Allow user to set Authorization

func (*GetAllSubscriptionsOptions) SetHeaders

func (options *GetAllSubscriptionsOptions) SetHeaders(param map[string]string) *GetAllSubscriptionsOptions

SetHeaders : Allow user to set Headers

func (*GetAllSubscriptionsOptions) SetType

SetType : Allow user to set Type

type GetEndpointOptions

type GetEndpointOptions struct {
	// Endpoint Id.
	ID *string `json:"id" validate:"required"`

	// Service Instance CRN.
	ServiceInstanceCrn *string `json:"service_instance_crn" validate:"required"`

	// User IAM token.
	Authorization *string `json:"authorization" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetEndpointOptions : The GetEndpoint options.

func (*GetEndpointOptions) SetAuthorization

func (options *GetEndpointOptions) SetAuthorization(authorization string) *GetEndpointOptions

SetAuthorization : Allow user to set Authorization

func (*GetEndpointOptions) SetHeaders

func (options *GetEndpointOptions) SetHeaders(param map[string]string) *GetEndpointOptions

SetHeaders : Allow user to set Headers

func (*GetEndpointOptions) SetID

func (options *GetEndpointOptions) SetID(id string) *GetEndpointOptions

SetID : Allow user to set ID

func (*GetEndpointOptions) SetServiceInstanceCrn

func (options *GetEndpointOptions) SetServiceInstanceCrn(serviceInstanceCrn string) *GetEndpointOptions

SetServiceInstanceCrn : Allow user to set ServiceInstanceCrn

type GetEndpointSwaggerOptions

type GetEndpointSwaggerOptions struct {
	// Endpoint Id.
	ID *string `json:"id" validate:"required"`

	// Service Instance CRN.
	ServiceInstanceCrn *string `json:"service_instance_crn" validate:"required"`

	// User IAM token.
	Authorization *string `json:"authorization" validate:"required"`

	// Type of swagger to retrieve.
	Type *string `json:"type,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetEndpointSwaggerOptions : The GetEndpointSwagger options.

func (*GetEndpointSwaggerOptions) SetAuthorization

func (options *GetEndpointSwaggerOptions) SetAuthorization(authorization string) *GetEndpointSwaggerOptions

SetAuthorization : Allow user to set Authorization

func (*GetEndpointSwaggerOptions) SetHeaders

func (options *GetEndpointSwaggerOptions) SetHeaders(param map[string]string) *GetEndpointSwaggerOptions

SetHeaders : Allow user to set Headers

func (*GetEndpointSwaggerOptions) SetID

SetID : Allow user to set ID

func (*GetEndpointSwaggerOptions) SetServiceInstanceCrn

func (options *GetEndpointSwaggerOptions) SetServiceInstanceCrn(serviceInstanceCrn string) *GetEndpointSwaggerOptions

SetServiceInstanceCrn : Allow user to set ServiceInstanceCrn

func (*GetEndpointSwaggerOptions) SetType

func (options *GetEndpointSwaggerOptions) SetType(typeVar string) *GetEndpointSwaggerOptions

SetType : Allow user to set Type

type GetSubscriptionArtifactOptions

type GetSubscriptionArtifactOptions struct {
	// Artifact Id.
	ArtifactID *string `json:"artifact_id" validate:"required"`

	// Client Id.
	ClientID *string `json:"client_id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetSubscriptionArtifactOptions : The GetSubscriptionArtifact options.

func (*GetSubscriptionArtifactOptions) SetArtifactID

func (options *GetSubscriptionArtifactOptions) SetArtifactID(artifactID string) *GetSubscriptionArtifactOptions

SetArtifactID : Allow user to set ArtifactID

func (*GetSubscriptionArtifactOptions) SetClientID

SetClientID : Allow user to set ClientID

func (*GetSubscriptionArtifactOptions) SetHeaders

SetHeaders : Allow user to set Headers

type GetSubscriptionOptions

type GetSubscriptionOptions struct {
	// Client Id.
	ID *string `json:"id" validate:"required"`

	// Artifact Id.
	ArtifactID *string `json:"artifact_id" validate:"required"`

	// User bearer token.
	Authorization *string `json:"authorization" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetSubscriptionOptions : The GetSubscription options.

func (*GetSubscriptionOptions) SetArtifactID

func (options *GetSubscriptionOptions) SetArtifactID(artifactID string) *GetSubscriptionOptions

SetArtifactID : Allow user to set ArtifactID

func (*GetSubscriptionOptions) SetAuthorization

func (options *GetSubscriptionOptions) SetAuthorization(authorization string) *GetSubscriptionOptions

SetAuthorization : Allow user to set Authorization

func (*GetSubscriptionOptions) SetHeaders

func (options *GetSubscriptionOptions) SetHeaders(param map[string]string) *GetSubscriptionOptions

SetHeaders : Allow user to set Headers

func (*GetSubscriptionOptions) SetID

SetID : Allow user to set ID

type InlineResponse200

type InlineResponse200 struct {
	OpenApiDoc interface{} `json:"open_api_doc,omitempty"`

	ManagedURL *string `json:"managed_url,omitempty"`
}

InlineResponse200 : Subscription artifact requested.

func UnmarshalInlineResponse200

func UnmarshalInlineResponse200(m map[string]interface{}) (result *InlineResponse200, err error)

UnmarshalInlineResponse200 constructs an instance of InlineResponse200 from the specified map.

func UnmarshalInlineResponse200AsProperty

func UnmarshalInlineResponse200AsProperty(m map[string]interface{}, propertyName string) (result *InlineResponse200, err error)

UnmarshalInlineResponse200AsProperty unmarshals an instance of InlineResponse200 that is stored as a property within the specified map.

func UnmarshalInlineResponse200Slice

func UnmarshalInlineResponse200Slice(s []interface{}) (slice []InlineResponse200, err error)

UnmarshalInlineResponse200Slice unmarshals a slice of InlineResponse200 instances from the specified list of maps.

func UnmarshalInlineResponse200SliceAsProperty

func UnmarshalInlineResponse200SliceAsProperty(m map[string]interface{}, propertyName string) (slice []InlineResponse200, err error)

UnmarshalInlineResponse200SliceAsProperty unmarshals a slice of InlineResponse200 instances that are stored as a property within the specified map.

type UpdateEndpointOptions

type UpdateEndpointOptions struct {
	// Endpoint Id.
	ID *string `json:"id" validate:"required"`

	// Service Instance CRN.
	ServiceInstanceCrn *string `json:"service_instance_crn" validate:"required"`

	// User IAM token.
	Authorization *string `json:"authorization" validate:"required"`

	// The endpoint ID.
	NewArtifactID *string `json:"new_artifact_id" validate:"required"`

	// The API Gateway service instance CRN.
	NewParentCrn *string `json:"new_parent_crn" validate:"required"`

	// The API Gateway service instance CRN.
	NewServiceInstanceCrn *string `json:"new_service_instance_crn" validate:"required"`

	// The endpoint's name.
	NewName *string `json:"new_name,omitempty"`

	// Invokable endpoint routes.
	NewRoutes []string `json:"new_routes,omitempty"`

	// Is the endpoint managed?.
	NewManaged *bool `json:"new_managed,omitempty"`

	NewMetadata interface{} `json:"new_metadata,omitempty"`

	// The OpenAPI document.
	NewOpenApiDoc interface{} `json:"new_open_api_doc,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateEndpointOptions : The UpdateEndpoint options.

func (*UpdateEndpointOptions) SetAuthorization

func (options *UpdateEndpointOptions) SetAuthorization(authorization string) *UpdateEndpointOptions

SetAuthorization : Allow user to set Authorization

func (*UpdateEndpointOptions) SetHeaders

func (options *UpdateEndpointOptions) SetHeaders(param map[string]string) *UpdateEndpointOptions

SetHeaders : Allow user to set Headers

func (*UpdateEndpointOptions) SetID

SetID : Allow user to set ID

func (*UpdateEndpointOptions) SetNewArtifactID

func (options *UpdateEndpointOptions) SetNewArtifactID(newArtifactID string) *UpdateEndpointOptions

SetNewArtifactID : Allow user to set NewArtifactID

func (*UpdateEndpointOptions) SetNewManaged

func (options *UpdateEndpointOptions) SetNewManaged(newManaged bool) *UpdateEndpointOptions

SetNewManaged : Allow user to set NewManaged

func (*UpdateEndpointOptions) SetNewMetadata

func (options *UpdateEndpointOptions) SetNewMetadata(newMetadata interface{}) *UpdateEndpointOptions

SetNewMetadata : Allow user to set NewMetadata

func (*UpdateEndpointOptions) SetNewName

func (options *UpdateEndpointOptions) SetNewName(newName string) *UpdateEndpointOptions

SetNewName : Allow user to set NewName

func (*UpdateEndpointOptions) SetNewOpenApiDoc

func (options *UpdateEndpointOptions) SetNewOpenApiDoc(newOpenApiDoc interface{}) *UpdateEndpointOptions

SetNewOpenApiDoc : Allow user to set NewOpenApiDoc

func (*UpdateEndpointOptions) SetNewParentCrn

func (options *UpdateEndpointOptions) SetNewParentCrn(newParentCrn string) *UpdateEndpointOptions

SetNewParentCrn : Allow user to set NewParentCrn

func (*UpdateEndpointOptions) SetNewRoutes

func (options *UpdateEndpointOptions) SetNewRoutes(newRoutes []string) *UpdateEndpointOptions

SetNewRoutes : Allow user to set NewRoutes

func (*UpdateEndpointOptions) SetNewServiceInstanceCrn

func (options *UpdateEndpointOptions) SetNewServiceInstanceCrn(newServiceInstanceCrn string) *UpdateEndpointOptions

SetNewServiceInstanceCrn : Allow user to set NewServiceInstanceCrn

func (*UpdateEndpointOptions) SetServiceInstanceCrn

func (options *UpdateEndpointOptions) SetServiceInstanceCrn(serviceInstanceCrn string) *UpdateEndpointOptions

SetServiceInstanceCrn : Allow user to set ServiceInstanceCrn

type UpdateSubscriptionOptions

type UpdateSubscriptionOptions struct {
	// Client Id.
	ID *string `json:"id" validate:"required"`

	// Artifact Id.
	ArtifactID *string `json:"artifact_id" validate:"required"`

	// User bearer token.
	Authorization *string `json:"authorization" validate:"required"`

	NewClientID *string `json:"new_client_id,omitempty"`

	NewClientSecret *string `json:"new_client_secret,omitempty"`

	NewArtifactID *string `json:"new_artifact_id,omitempty"`

	NewAccountID *string `json:"new_account_id,omitempty"`

	NewName *string `json:"new_name,omitempty"`

	NewType *string `json:"new_type,omitempty"`

	NewMetadata interface{} `json:"new_metadata,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateSubscriptionOptions : The UpdateSubscription options.

func (*UpdateSubscriptionOptions) SetArtifactID

func (options *UpdateSubscriptionOptions) SetArtifactID(artifactID string) *UpdateSubscriptionOptions

SetArtifactID : Allow user to set ArtifactID

func (*UpdateSubscriptionOptions) SetAuthorization

func (options *UpdateSubscriptionOptions) SetAuthorization(authorization string) *UpdateSubscriptionOptions

SetAuthorization : Allow user to set Authorization

func (*UpdateSubscriptionOptions) SetHeaders

func (options *UpdateSubscriptionOptions) SetHeaders(param map[string]string) *UpdateSubscriptionOptions

SetHeaders : Allow user to set Headers

func (*UpdateSubscriptionOptions) SetID

SetID : Allow user to set ID

func (*UpdateSubscriptionOptions) SetNewAccountID

func (options *UpdateSubscriptionOptions) SetNewAccountID(newAccountID string) *UpdateSubscriptionOptions

SetNewAccountID : Allow user to set NewAccountID

func (*UpdateSubscriptionOptions) SetNewArtifactID

func (options *UpdateSubscriptionOptions) SetNewArtifactID(newArtifactID string) *UpdateSubscriptionOptions

SetNewArtifactID : Allow user to set NewArtifactID

func (*UpdateSubscriptionOptions) SetNewClientID

func (options *UpdateSubscriptionOptions) SetNewClientID(newClientID string) *UpdateSubscriptionOptions

SetNewClientID : Allow user to set NewClientID

func (*UpdateSubscriptionOptions) SetNewClientSecret

func (options *UpdateSubscriptionOptions) SetNewClientSecret(newClientSecret string) *UpdateSubscriptionOptions

SetNewClientSecret : Allow user to set NewClientSecret

func (*UpdateSubscriptionOptions) SetNewMetadata

func (options *UpdateSubscriptionOptions) SetNewMetadata(newMetadata interface{}) *UpdateSubscriptionOptions

SetNewMetadata : Allow user to set NewMetadata

func (*UpdateSubscriptionOptions) SetNewName

func (options *UpdateSubscriptionOptions) SetNewName(newName string) *UpdateSubscriptionOptions

SetNewName : Allow user to set NewName

func (*UpdateSubscriptionOptions) SetNewType

func (options *UpdateSubscriptionOptions) SetNewType(newType string) *UpdateSubscriptionOptions

SetNewType : Allow user to set NewType

type V2DiscoveryConfig

type V2DiscoveryConfig struct {
	Headers interface{} `json:"headers,omitempty"`

	BridgeURL *string `json:"bridge_url" validate:"required"`
}

V2DiscoveryConfig : V2DiscoveryConfig struct

func UnmarshalV2DiscoveryConfig

func UnmarshalV2DiscoveryConfig(m map[string]interface{}) (result *V2DiscoveryConfig, err error)

UnmarshalV2DiscoveryConfig constructs an instance of V2DiscoveryConfig from the specified map.

func UnmarshalV2DiscoveryConfigAsProperty

func UnmarshalV2DiscoveryConfigAsProperty(m map[string]interface{}, propertyName string) (result *V2DiscoveryConfig, err error)

UnmarshalV2DiscoveryConfigAsProperty unmarshals an instance of V2DiscoveryConfig that is stored as a property within the specified map.

func UnmarshalV2DiscoveryConfigSlice

func UnmarshalV2DiscoveryConfigSlice(s []interface{}) (slice []V2DiscoveryConfig, err error)

UnmarshalV2DiscoveryConfigSlice unmarshals a slice of V2DiscoveryConfig instances from the specified list of maps.

func UnmarshalV2DiscoveryConfigSliceAsProperty

func UnmarshalV2DiscoveryConfigSliceAsProperty(m map[string]interface{}, propertyName string) (slice []V2DiscoveryConfig, err error)

UnmarshalV2DiscoveryConfigSliceAsProperty unmarshals a slice of V2DiscoveryConfig instances that are stored as a property within the specified map.

type V2Endpoint

type V2Endpoint struct {
	// The endpoint ID.
	ArtifactID *string `json:"artifact_id" validate:"required"`

	// The endpoint CRN.
	Crn *string `json:"crn" validate:"required"`

	// The API Gateway service instance CRN.
	ParentCrn *string `json:"parent_crn" validate:"required"`

	// The API Gateway service instance CRN.
	ServiceInstanceCrn *string `json:"service_instance_crn,omitempty"`

	// The account where the API Gateway service instance was provisioned.
	AccountID *string `json:"account_id,omitempty"`

	// Endpoint metadata.
	Metadata interface{} `json:"metadata,omitempty"`

	// The provider type of this endpoint.
	ProviderID *string `json:"provider_id,omitempty"`

	// THe endpoint's name.
	Name *string `json:"name,omitempty"`

	// Invokable endpoint routes.
	Routes []string `json:"routes,omitempty"`

	// Invoke your endpoint with this URL.
	ManagedURL *string `json:"managed_url,omitempty"`

	// Invoke your endpoint with this alias URL.
	AliasURL *string `json:"alias_url,omitempty"`

	// Is your endpoint shared?.
	Shared *bool `json:"shared,omitempty"`

	// Is your endpoint managed by the API Gateway service instance?.
	Managed *bool `json:"managed,omitempty"`

	// Policies enforced on the endpoint.
	Policies []map[string]interface{} `json:"policies,omitempty"`

	// THe OpenAPI doc representing the endpoint.
	OpenApiDoc map[string]interface{} `json:"open_api_doc,omitempty"`

	// The base path of the endpoint.
	BasePath *string `json:"base_path,omitempty"`
}

V2Endpoint : V2Endpoint struct

func UnmarshalV2Endpoint

func UnmarshalV2Endpoint(m map[string]interface{}) (result *V2Endpoint, err error)

UnmarshalV2Endpoint constructs an instance of V2Endpoint from the specified map.

func UnmarshalV2EndpointAsProperty

func UnmarshalV2EndpointAsProperty(m map[string]interface{}, propertyName string) (result *V2Endpoint, err error)

UnmarshalV2EndpointAsProperty unmarshals an instance of V2Endpoint that is stored as a property within the specified map.

func UnmarshalV2EndpointSlice

func UnmarshalV2EndpointSlice(s []interface{}) (slice []V2Endpoint, err error)

UnmarshalV2EndpointSlice unmarshals a slice of V2Endpoint instances from the specified list of maps.

func UnmarshalV2EndpointSliceAsProperty

func UnmarshalV2EndpointSliceAsProperty(m map[string]interface{}, propertyName string) (slice []V2Endpoint, err error)

UnmarshalV2EndpointSliceAsProperty unmarshals a slice of V2Endpoint instances that are stored as a property within the specified map.

type V2EndpointSummary

type V2EndpointSummary struct {
	ID *string `json:"id,omitempty"`

	DisplayName *string `json:"display_name,omitempty"`

	Metadata interface{} `json:"metadata,omitempty"`

	Discoverable *bool `json:"discoverable,omitempty"`

	DiscoveryConfig *V2DiscoveryConfig `json:"discovery_config,omitempty"`

	Endpoints []V2Endpoint `json:"endpoints,omitempty"`
}

V2EndpointSummary : V2EndpointSummary struct

func UnmarshalV2EndpointSummary

func UnmarshalV2EndpointSummary(m map[string]interface{}) (result *V2EndpointSummary, err error)

UnmarshalV2EndpointSummary constructs an instance of V2EndpointSummary from the specified map.

func UnmarshalV2EndpointSummaryAsProperty

func UnmarshalV2EndpointSummaryAsProperty(m map[string]interface{}, propertyName string) (result *V2EndpointSummary, err error)

UnmarshalV2EndpointSummaryAsProperty unmarshals an instance of V2EndpointSummary that is stored as a property within the specified map.

func UnmarshalV2EndpointSummarySlice

func UnmarshalV2EndpointSummarySlice(s []interface{}) (slice []V2EndpointSummary, err error)

UnmarshalV2EndpointSummarySlice unmarshals a slice of V2EndpointSummary instances from the specified list of maps.

func UnmarshalV2EndpointSummarySliceAsProperty

func UnmarshalV2EndpointSummarySliceAsProperty(m map[string]interface{}, propertyName string) (slice []V2EndpointSummary, err error)

UnmarshalV2EndpointSummarySliceAsProperty unmarshals a slice of V2EndpointSummary instances that are stored as a property within the specified map.

type V2Subscription

type V2Subscription struct {
	ClientID *string `json:"client_id" ,omitempty`

	SecretProvided *bool `json:"secret_provided,omitempty"`

	ArtifactID *string `json:"artifact_id" validate:"required"`

	AccountID *string `json:"account_id,omitempty"`

	Name *string `json:"name,omitempty"`

	Type *string `json:"type,omitempty"`

	Metadata interface{} `json:"metadata,omitempty"`
}

V2Subscription : V2Subscription struct

func UnmarshalV2Subscription

func UnmarshalV2Subscription(m map[string]interface{}) (result *V2Subscription, err error)

UnmarshalV2Subscription constructs an instance of V2Subscription from the specified map.

func UnmarshalV2SubscriptionAsProperty

func UnmarshalV2SubscriptionAsProperty(m map[string]interface{}, propertyName string) (result *V2Subscription, err error)

UnmarshalV2SubscriptionAsProperty unmarshals an instance of V2Subscription that is stored as a property within the specified map.

func UnmarshalV2SubscriptionSlice

func UnmarshalV2SubscriptionSlice(s []interface{}) (slice []V2Subscription, err error)

UnmarshalV2SubscriptionSlice unmarshals a slice of V2Subscription instances from the specified list of maps.

func UnmarshalV2SubscriptionSliceAsProperty

func UnmarshalV2SubscriptionSliceAsProperty(m map[string]interface{}, propertyName string) (slice []V2Subscription, err error)

UnmarshalV2SubscriptionSliceAsProperty unmarshals a slice of V2Subscription instances that are stored as a property within the specified map.

Jump to

Keyboard shortcuts

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