ibmlogsrouteropenapi30v0

package
v1.0.0 Latest Latest
Warning

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

Go to latest
Published: Nov 21, 2023 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package ibmlogsrouteropenapi30v0 : Operations and models for the IbmLogsRouterOpenApi30V0 service

Index

Constants

View Source
const DefaultServiceName = "ibm_logs_router_open_api_3_0"

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

View Source
const DefaultServiceURL = "https://management.us-east.logs-router.cloud.ibm.com/v1"

DefaultServiceURL is the default URL to make service requests to.

View Source
const ParameterizedServiceURL = "https://management.{region}.logs-router.cloud.ibm.com/v1"

Variables

This section is empty.

Functions

func ConstructServiceURL

func ConstructServiceURL(providedUrlVariables map[string]string) (string, error)

ConstructServiceURL constructs a service URL from the parameterized URL.

func GetServiceURLForRegion

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalTenantDeleteResponse

func UnmarshalTenantDeleteResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTenantDeleteResponse unmarshals an instance of TenantDeleteResponse from the specified map of raw messages.

func UnmarshalTenantDetailsResponse

func UnmarshalTenantDetailsResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTenantDetailsResponse unmarshals an instance of TenantDetailsResponse from the specified map of raw messages.

func UnmarshalTenantDetailsResponseCollection

func UnmarshalTenantDetailsResponseCollection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTenantDetailsResponseCollection unmarshals an instance of TenantDetailsResponseCollection from the specified map of raw messages.

func UnmarshalTenantDetailsResponsePatch

func UnmarshalTenantDetailsResponsePatch(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTenantDetailsResponsePatch unmarshals an instance of TenantDetailsResponsePatch from the specified map of raw messages.

Types

type CreateTenantOptions

type CreateTenantOptions struct {
	// Type of log-sink to connect to. Supported: [logdna].
	TargetType *string `json:"target_type" validate:"required"`

	// Full qualified host name of log-sink.
	TargetHost *string `json:"target_host" validate:"required"`

	// Port number at target_host of log-sink.
	TargetPort *int64 `json:"target_port" validate:"required"`

	// Secret to connect to the log-sink.
	AccessCredential *string `json:"access_credential" validate:"required"`

	// Cloud resource name of the log-sink target instance.
	TargetInstanceCrn *string `json:"target_instance_crn" validate:"required"`

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

CreateTenantOptions : The CreateTenant options.

func (*CreateTenantOptions) SetAccessCredential

func (_options *CreateTenantOptions) SetAccessCredential(accessCredential string) *CreateTenantOptions

SetAccessCredential : Allow user to set AccessCredential

func (*CreateTenantOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*CreateTenantOptions) SetTargetHost

func (_options *CreateTenantOptions) SetTargetHost(targetHost string) *CreateTenantOptions

SetTargetHost : Allow user to set TargetHost

func (*CreateTenantOptions) SetTargetInstanceCrn

func (_options *CreateTenantOptions) SetTargetInstanceCrn(targetInstanceCrn string) *CreateTenantOptions

SetTargetInstanceCrn : Allow user to set TargetInstanceCrn

func (*CreateTenantOptions) SetTargetPort

func (_options *CreateTenantOptions) SetTargetPort(targetPort int64) *CreateTenantOptions

SetTargetPort : Allow user to set TargetPort

func (*CreateTenantOptions) SetTargetType

func (_options *CreateTenantOptions) SetTargetType(targetType string) *CreateTenantOptions

SetTargetType : Allow user to set TargetType

type DeleteTenantOptions

type DeleteTenantOptions struct {
	// The instance ID of the tenant.
	TenantID *strfmt.UUID `json:"tenant_id" validate:"required"`

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

DeleteTenantOptions : The DeleteTenant options.

func (*DeleteTenantOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*DeleteTenantOptions) SetTenantID

func (_options *DeleteTenantOptions) SetTenantID(tenantID *strfmt.UUID) *DeleteTenantOptions

SetTenantID : Allow user to set TenantID

type GetTenantDetailOptions

type GetTenantDetailOptions struct {
	// The instance ID of the tenant.
	TenantID *strfmt.UUID `json:"tenant_id" validate:"required"`

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

GetTenantDetailOptions : The GetTenantDetail options.

func (*GetTenantDetailOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetTenantDetailOptions) SetTenantID

func (_options *GetTenantDetailOptions) SetTenantID(tenantID *strfmt.UUID) *GetTenantDetailOptions

SetTenantID : Allow user to set TenantID

type IbmLogsRouterOpenApi30V0

type IbmLogsRouterOpenApi30V0 struct {
	Service *core.BaseService
}

IbmLogsRouterOpenApi30V0 : IBM logs-router is an IBM cloud platform service to collect log-events of your VPC and deliver them to the configured log sink.

API Version: 0.0.1 See: http://cloud.ibm.com

func NewIbmLogsRouterOpenApi30V0

func NewIbmLogsRouterOpenApi30V0(options *IbmLogsRouterOpenApi30V0Options) (service *IbmLogsRouterOpenApi30V0, err error)

NewIbmLogsRouterOpenApi30V0 : constructs an instance of IbmLogsRouterOpenApi30V0 with passed in options.

func NewIbmLogsRouterOpenApi30V0UsingExternalConfig

func NewIbmLogsRouterOpenApi30V0UsingExternalConfig(options *IbmLogsRouterOpenApi30V0Options) (ibmLogsRouterOpenApi30 *IbmLogsRouterOpenApi30V0, err error)

NewIbmLogsRouterOpenApi30V0UsingExternalConfig : constructs an instance of IbmLogsRouterOpenApi30V0 with passed in options and external configuration.

func (*IbmLogsRouterOpenApi30V0) Clone

func (ibmLogsRouterOpenApi30 *IbmLogsRouterOpenApi30V0) Clone() *IbmLogsRouterOpenApi30V0

Clone makes a copy of "ibmLogsRouterOpenApi30" suitable for processing requests.

func (*IbmLogsRouterOpenApi30V0) CreateTenant

func (ibmLogsRouterOpenApi30 *IbmLogsRouterOpenApi30V0) CreateTenant(createTenantOptions *CreateTenantOptions) (result *TenantDetailsResponse, response *core.DetailedResponse, err error)

CreateTenant : Create (onboard) a new tenant Create (onboard) a new tenant.

func (*IbmLogsRouterOpenApi30V0) CreateTenantWithContext

func (ibmLogsRouterOpenApi30 *IbmLogsRouterOpenApi30V0) CreateTenantWithContext(ctx context.Context, createTenantOptions *CreateTenantOptions) (result *TenantDetailsResponse, response *core.DetailedResponse, err error)

CreateTenantWithContext is an alternate form of the CreateTenant method which supports a Context parameter

func (*IbmLogsRouterOpenApi30V0) DeleteTenant

func (ibmLogsRouterOpenApi30 *IbmLogsRouterOpenApi30V0) DeleteTenant(deleteTenantOptions *DeleteTenantOptions) (result *TenantDeleteResponse, response *core.DetailedResponse, err error)

DeleteTenant : Delete (offboard) a tenant Delete (offboard) a tenant.

func (*IbmLogsRouterOpenApi30V0) DeleteTenantWithContext

func (ibmLogsRouterOpenApi30 *IbmLogsRouterOpenApi30V0) DeleteTenantWithContext(ctx context.Context, deleteTenantOptions *DeleteTenantOptions) (result *TenantDeleteResponse, response *core.DetailedResponse, err error)

DeleteTenantWithContext is an alternate form of the DeleteTenant method which supports a Context parameter

func (*IbmLogsRouterOpenApi30V0) DisableRetries

func (ibmLogsRouterOpenApi30 *IbmLogsRouterOpenApi30V0) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*IbmLogsRouterOpenApi30V0) EnableRetries

func (ibmLogsRouterOpenApi30 *IbmLogsRouterOpenApi30V0) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*IbmLogsRouterOpenApi30V0) GetEnableGzipCompression

func (ibmLogsRouterOpenApi30 *IbmLogsRouterOpenApi30V0) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*IbmLogsRouterOpenApi30V0) GetServiceURL

func (ibmLogsRouterOpenApi30 *IbmLogsRouterOpenApi30V0) GetServiceURL() string

GetServiceURL returns the service URL

func (*IbmLogsRouterOpenApi30V0) GetTenantDetail

func (ibmLogsRouterOpenApi30 *IbmLogsRouterOpenApi30V0) GetTenantDetail(getTenantDetailOptions *GetTenantDetailOptions) (result *TenantDetailsResponse, response *core.DetailedResponse, err error)

GetTenantDetail : Details of a tenant List the details of the given tenant.

func (*IbmLogsRouterOpenApi30V0) GetTenantDetailWithContext

func (ibmLogsRouterOpenApi30 *IbmLogsRouterOpenApi30V0) GetTenantDetailWithContext(ctx context.Context, getTenantDetailOptions *GetTenantDetailOptions) (result *TenantDetailsResponse, response *core.DetailedResponse, err error)

GetTenantDetailWithContext is an alternate form of the GetTenantDetail method which supports a Context parameter

func (*IbmLogsRouterOpenApi30V0) ListTenants

func (ibmLogsRouterOpenApi30 *IbmLogsRouterOpenApi30V0) ListTenants(listTenantsOptions *ListTenantsOptions) (result *TenantDetailsResponseCollection, response *core.DetailedResponse, err error)

ListTenants : List of tenants List of tenants defined in your account.

func (*IbmLogsRouterOpenApi30V0) ListTenantsWithContext

func (ibmLogsRouterOpenApi30 *IbmLogsRouterOpenApi30V0) ListTenantsWithContext(ctx context.Context, listTenantsOptions *ListTenantsOptions) (result *TenantDetailsResponseCollection, response *core.DetailedResponse, err error)

ListTenantsWithContext is an alternate form of the ListTenants method which supports a Context parameter

func (*IbmLogsRouterOpenApi30V0) NewCreateTenantOptions

func (*IbmLogsRouterOpenApi30V0) NewCreateTenantOptions(targetType string, targetHost string, targetPort int64, accessCredential string, targetInstanceCrn string) *CreateTenantOptions

NewCreateTenantOptions : Instantiate CreateTenantOptions

func (*IbmLogsRouterOpenApi30V0) NewDeleteTenantOptions

func (*IbmLogsRouterOpenApi30V0) NewDeleteTenantOptions(tenantID *strfmt.UUID) *DeleteTenantOptions

NewDeleteTenantOptions : Instantiate DeleteTenantOptions

func (*IbmLogsRouterOpenApi30V0) NewGetTenantDetailOptions

func (*IbmLogsRouterOpenApi30V0) NewGetTenantDetailOptions(tenantID *strfmt.UUID) *GetTenantDetailOptions

NewGetTenantDetailOptions : Instantiate GetTenantDetailOptions

func (*IbmLogsRouterOpenApi30V0) NewListTenantsOptions

func (*IbmLogsRouterOpenApi30V0) NewListTenantsOptions() *ListTenantsOptions

NewListTenantsOptions : Instantiate ListTenantsOptions

func (*IbmLogsRouterOpenApi30V0) NewUpdateTargetOptions

func (*IbmLogsRouterOpenApi30V0) NewUpdateTargetOptions(tenantID *strfmt.UUID, tenantDetailsResponsePatch map[string]interface{}) *UpdateTargetOptions

NewUpdateTargetOptions : Instantiate UpdateTargetOptions

func (*IbmLogsRouterOpenApi30V0) SetDefaultHeaders

func (ibmLogsRouterOpenApi30 *IbmLogsRouterOpenApi30V0) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*IbmLogsRouterOpenApi30V0) SetEnableGzipCompression

func (ibmLogsRouterOpenApi30 *IbmLogsRouterOpenApi30V0) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*IbmLogsRouterOpenApi30V0) SetServiceURL

func (ibmLogsRouterOpenApi30 *IbmLogsRouterOpenApi30V0) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*IbmLogsRouterOpenApi30V0) UpdateTarget

func (ibmLogsRouterOpenApi30 *IbmLogsRouterOpenApi30V0) UpdateTarget(updateTargetOptions *UpdateTargetOptions) (result *TenantDetailsResponse, response *core.DetailedResponse, err error)

UpdateTarget : Update the target of a tenant Update the target of a tenant.

func (*IbmLogsRouterOpenApi30V0) UpdateTargetWithContext

func (ibmLogsRouterOpenApi30 *IbmLogsRouterOpenApi30V0) UpdateTargetWithContext(ctx context.Context, updateTargetOptions *UpdateTargetOptions) (result *TenantDetailsResponse, response *core.DetailedResponse, err error)

UpdateTargetWithContext is an alternate form of the UpdateTarget method which supports a Context parameter

type IbmLogsRouterOpenApi30V0Options

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

IbmLogsRouterOpenApi30V0Options : Service options

type ListTenantsOptions

type ListTenantsOptions struct {

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

ListTenantsOptions : The ListTenants options.

func (*ListTenantsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

type TenantDeleteResponse

type TenantDeleteResponse struct {
	// HTTP status code.
	Status *int64 `json:"status,omitempty"`

	// Status message.
	Message *string `json:"message,omitempty"`
}

TenantDeleteResponse : Response body from successful delete tenant operation.

type TenantDetailsResponse

type TenantDetailsResponse struct {
	// Unique ID of the created instance.
	ID *strfmt.UUID `json:"id,omitempty"`

	// The account ID the tenant belongs to.
	AccountID *string `json:"account_id,omitempty"`

	// Type of log-sink.
	TargetType *string `json:"target_type,omitempty"`

	// Host name of log-sink.
	TargetHost *string `json:"target_host,omitempty"`

	// Network port of log sink.
	TargetPort *int64 `json:"target_port,omitempty"`

	// Cloud resource name of the log-sink target instance.
	TargetInstanceCrn *string `json:"target_instance_crn,omitempty"`

	// Time stamp the tenant was originally created.
	CreatedAt *string `json:"created_at,omitempty"`

	// time stamp the tenant was last updated.
	UpdatedAt *string `json:"updated_at,omitempty"`
}

TenantDetailsResponse : Response body from a successful list tenant details operation.

type TenantDetailsResponseCollection

type TenantDetailsResponseCollection struct {
	// List of tenants in the account.
	Tenants []TenantDetailsResponse `json:"tenants,omitempty"`
}

TenantDetailsResponseCollection : Response body from a successful list tenants operation.

type TenantDetailsResponsePatch

type TenantDetailsResponsePatch struct {
	// Fully-qualified host name of log-sink.
	TargetHost *string `json:"target_host,omitempty"`

	// Port number at target_host of log-sink.
	TargetPort *int64 `json:"target_port,omitempty"`

	// Secret to connect to the log-sink.
	AccessCredential *string `json:"access_credential,omitempty"`

	// Cloud resource name of the log-sink target instance.
	TargetInstanceCrn *string `json:"target_instance_crn,omitempty"`
}

TenantDetailsResponsePatch : The request body used when updating the target of a tenant. At least one other value is required.

func (*TenantDetailsResponsePatch) AsPatch

func (tenantDetailsResponsePatch *TenantDetailsResponsePatch) AsPatch() (_patch map[string]interface{}, err error)

AsPatch returns a generic map representation of the TenantDetailsResponsePatch

type UpdateTargetOptions

type UpdateTargetOptions struct {
	// The instance ID of the tenant.
	TenantID *strfmt.UUID `json:"tenant_id" validate:"required"`

	// Updates the target setup. Only the listed fields can be updated and only the fields that need to be changed are
	// required in the body. At least one field must be specified for the update.
	TenantDetailsResponsePatch map[string]interface{} `json:"TenantDetailsResponse_patch" validate:"required"`

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

UpdateTargetOptions : The UpdateTarget options.

func (*UpdateTargetOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*UpdateTargetOptions) SetTenantDetailsResponsePatch

func (_options *UpdateTargetOptions) SetTenantDetailsResponsePatch(tenantDetailsResponsePatch map[string]interface{}) *UpdateTargetOptions

SetTenantDetailsResponsePatch : Allow user to set TenantDetailsResponsePatch

func (*UpdateTargetOptions) SetTenantID

func (_options *UpdateTargetOptions) SetTenantID(tenantID *strfmt.UUID) *UpdateTargetOptions

SetTenantID : Allow user to set TenantID

Jump to

Keyboard shortcuts

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