ibmanalyticsengineapiv3

package
v2.3.0 Latest Latest
Warning

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

 Go to latest Published: Oct 4, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package ibmanalyticsengineapiv3 : Operations and models for the IbmAnalyticsEngineApiV3 service

Index

Constants

View Source 
const (
	Application_State_Accepted       = "accepted"
	Application_State_AutoTerminated = "auto_terminated"
	Application_State_Failed         = "failed"
	Application_State_Finished       = "finished"
	Application_State_OpsTerminated  = "ops_terminated"
	Application_State_Running        = "running"
	Application_State_Stopped        = "stopped"
)

Constants associated with the Application.State property. State of the Spark application.

View Source 
const (
	ApplicationGetResponse_State_Accepted       = "accepted"
	ApplicationGetResponse_State_AutoTerminated = "auto_terminated"
	ApplicationGetResponse_State_Failed         = "failed"
	ApplicationGetResponse_State_Finished       = "finished"
	ApplicationGetResponse_State_OpsTerminated  = "ops_terminated"
	ApplicationGetResponse_State_Running        = "running"
	ApplicationGetResponse_State_Stopped        = "stopped"
)

Constants associated with the ApplicationGetResponse.State property. State of the Spark application.

View Source 
const (
	ApplicationGetResponseStateDetailsItem_Type_Info        = "info"
	ApplicationGetResponseStateDetailsItem_Type_ServerError = "server_error"
	ApplicationGetResponseStateDetailsItem_Type_UserError   = "user_error"
)

Constants associated with the ApplicationGetResponseStateDetailsItem.Type property. Type of the message.

View Source 
const (
	ApplicationGetStateResponse_State_Accepted       = "accepted"
	ApplicationGetStateResponse_State_AutoTerminated = "auto_terminated"
	ApplicationGetStateResponse_State_Failed         = "failed"
	ApplicationGetStateResponse_State_Finished       = "finished"
	ApplicationGetStateResponse_State_OpsTerminated  = "ops_terminated"
	ApplicationGetStateResponse_State_Running        = "running"
	ApplicationGetStateResponse_State_Stopped        = "stopped"
)

Constants associated with the ApplicationGetStateResponse.State property. State of the Spark application.

View Source 
const (
	ApplicationResponse_State_Accepted       = "accepted"
	ApplicationResponse_State_AutoTerminated = "auto_terminated"
	ApplicationResponse_State_Failed         = "failed"
	ApplicationResponse_State_Finished       = "finished"
	ApplicationResponse_State_OpsTerminated  = "ops_terminated"
	ApplicationResponse_State_Running        = "running"
	ApplicationResponse_State_Stopped        = "stopped"
)

Constants associated with the ApplicationResponse.State property. State of the Spark application.

View Source 
const (
	Instance_State_Active           = "active"
	Instance_State_CreationAccepted = "creation_accepted"
	Instance_State_CreationFailed   = "creation_failed"
	Instance_State_Deleted          = "deleted"
	Instance_State_Disabled         = "disabled"
	Instance_State_Initialized      = "initialized"
	Instance_State_Preparing        = "preparing"
)

Constants associated with the Instance.State property. State of the Analytics Engine instance.

View Source 
const (
	InstanceGetStateResponse_State_Active           = "active"
	InstanceGetStateResponse_State_CreationAccepted = "creation_accepted"
	InstanceGetStateResponse_State_CreationFailed   = "creation_failed"
	InstanceGetStateResponse_State_Deleted          = "deleted"
	InstanceGetStateResponse_State_Disabled         = "disabled"
	InstanceGetStateResponse_State_Initialized      = "initialized"
	InstanceGetStateResponse_State_Preparing        = "preparing"
)

Constants associated with the InstanceGetStateResponse.State property. State of the Analytics Engine instance.

View Source 
const (
	ListApplicationsOptions_State_Accepted       = "accepted"
	ListApplicationsOptions_State_AutoTerminated = "auto_terminated"
	ListApplicationsOptions_State_Failed         = "failed"
	ListApplicationsOptions_State_Finished       = "finished"
	ListApplicationsOptions_State_OpsTerminated  = "ops_terminated"
	ListApplicationsOptions_State_Running        = "running"
	ListApplicationsOptions_State_Stopped        = "stopped"
)

Constants associated with the ListApplicationsOptions.State property. State of the Spark application.

View Source 
const (
	SparkHistoryServerResponse_State_Started = "started"
	SparkHistoryServerResponse_State_Stopped = "stopped"
)

Constants associated with the SparkHistoryServerResponse.State property. State of the Spark history server.

View Source 
const DefaultServiceName = "ibm_analytics_engine_api" //#nosec G101

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

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

DefaultServiceURL is the default URL to make service requests to.

Variables

This section is empty.

Functions

func GetServiceURLForRegion 

func GetServiceURLForRegion(region string) (string, error)

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

func UnmarshalApplication 

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

UnmarshalApplication unmarshals an instance of Application from the specified map of raw messages.

func UnmarshalApplicationCollection 

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

UnmarshalApplicationCollection unmarshals an instance of ApplicationCollection from the specified map of raw messages.

func UnmarshalApplicationDetails 

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

UnmarshalApplicationDetails unmarshals an instance of ApplicationDetails from the specified map of raw messages.

func UnmarshalApplicationGetResponse 

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

UnmarshalApplicationGetResponse unmarshals an instance of ApplicationGetResponse from the specified map of raw messages.

func UnmarshalApplicationGetResponseStateDetailsItem 

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

UnmarshalApplicationGetResponseStateDetailsItem unmarshals an instance of ApplicationGetResponseStateDetailsItem from the specified map of raw messages.

func UnmarshalApplicationGetStateResponse 

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

UnmarshalApplicationGetStateResponse unmarshals an instance of ApplicationGetStateResponse from the specified map of raw messages.

func UnmarshalApplicationResponse 

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

UnmarshalApplicationResponse unmarshals an instance of ApplicationResponse from the specified map of raw messages.

func UnmarshalCurrentResourceConsumptionResponse 

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

UnmarshalCurrentResourceConsumptionResponse unmarshals an instance of CurrentResourceConsumptionResponse from the specified map of raw messages.

func UnmarshalInstance 

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

UnmarshalInstance unmarshals an instance of Instance from the specified map of raw messages.

func UnmarshalInstanceDefaultConfig 

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

UnmarshalInstanceDefaultConfig unmarshals an instance of InstanceDefaultConfig from the specified map of raw messages.

func UnmarshalInstanceGetStateResponse 

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

UnmarshalInstanceGetStateResponse unmarshals an instance of InstanceGetStateResponse from the specified map of raw messages.

func UnmarshalInstanceHome 

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

UnmarshalInstanceHome unmarshals an instance of InstanceHome from the specified map of raw messages.

func UnmarshalInstanceHomeResponse 

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

UnmarshalInstanceHomeResponse unmarshals an instance of InstanceHomeResponse from the specified map of raw messages.

func UnmarshalLogForwardingConfigResponse 

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

UnmarshalLogForwardingConfigResponse unmarshals an instance of LogForwardingConfigResponse from the specified map of raw messages.

func UnmarshalLogForwardingConfigResponseLogServer 

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

UnmarshalLogForwardingConfigResponseLogServer unmarshals an instance of LogForwardingConfigResponseLogServer from the specified map of raw messages.

func UnmarshalLoggingConfigurationResponse 

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

UnmarshalLoggingConfigurationResponse unmarshals an instance of LoggingConfigurationResponse from the specified map of raw messages.

func UnmarshalLoggingConfigurationResponseLogServer 

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

UnmarshalLoggingConfigurationResponseLogServer unmarshals an instance of LoggingConfigurationResponseLogServer from the specified map of raw messages. 

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

UnmarshalPageLink unmarshals an instance of PageLink from the specified map of raw messages.

func UnmarshalResourceConsumptionLimitsResponse 

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

UnmarshalResourceConsumptionLimitsResponse unmarshals an instance of ResourceConsumptionLimitsResponse from the specified map of raw messages.

func UnmarshalRuntime 

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

UnmarshalRuntime unmarshals an instance of Runtime from the specified map of raw messages.

func UnmarshalSparkHistoryServerResponse 

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

UnmarshalSparkHistoryServerResponse unmarshals an instance of SparkHistoryServerResponse from the specified map of raw messages.

Types

type Application 

type Application struct {
	// Identifier provided by Analytics Engine service for the Spark application.
	ID *string `json:"id,omitempty"`

	// Full URL of the resource.
	Href *string `json:"href,omitempty"`

	// Runtime enviroment for applications and other workloads.
	Runtime *Runtime `json:"runtime,omitempty"`

	// Identifier provided by Apache Spark for the application.
	SparkApplicationID *string `json:"spark_application_id,omitempty"`

	// Name of the Spark application.
	SparkApplicationName *string `json:"spark_application_name,omitempty"`

	// State of the Spark application.
	State *string `json:"state,omitempty"`

	// URL of the Apache Spark web UI that is available when the application is running.
	SparkUi *string `json:"spark_ui,omitempty"`

	// Time when the application was submitted.
	SubmissionTime *strfmt.DateTime `json:"submission_time,omitempty"`

	// Time when the application was started.
	StartTime *strfmt.DateTime `json:"start_time,omitempty"`

	// Time when the application run ended in success, failure or was stopped.
	EndTime *strfmt.DateTime `json:"end_time,omitempty"`

	// (deprecated) Time when the application was completed.
	// Deprecated: this field is deprecated and may be removed in a future release.
	FinishTime *strfmt.DateTime `json:"finish_time,omitempty"`

	// Time when the application will be automatically stopped by the service.
	AutoTerminationTime *strfmt.DateTime `json:"auto_termination_time,omitempty"`
}

Application : Details of a Spark application.

type ApplicationCollection 

type ApplicationCollection struct {
	// List of applications.
	Applications []Application `json:"applications" validate:"required"`

	// A reference to a page in a paginated collection.
	First *PageLink `json:"first,omitempty"`

	// A reference to a page in a paginated collection.
	Next *PageLink `json:"next,omitempty"`

	// A reference to a page in a paginated collection.
	Previous *PageLink `json:"previous,omitempty"`

	// The maximum number of results in this page of the collection.
	Limit *int64 `json:"limit" validate:"required"`
}

ApplicationCollection : A paginated collection of applications.

func (*ApplicationCollection) GetNextStart added in v2.2.0 

func (resp *ApplicationCollection) GetNextStart() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type ApplicationDetails 

type ApplicationDetails struct {
	// Path of the application to run.
	Application *string `json:"application,omitempty"`

	// Runtime enviroment for applications and other workloads.
	Runtime *Runtime `json:"runtime,omitempty"`

	// Path of the jar files containing the application.
	Jars *string `json:"jars,omitempty"`

	// Package names.
	Packages *string `json:"packages,omitempty"`

	// Repositories names.
	Repositories *string `json:"repositories,omitempty"`

	// File names.
	Files *string `json:"files,omitempty"`

	// Archive Names.
	Archives *string `json:"archives,omitempty"`

	// Name of the application.
	Name *string `json:"name,omitempty"`

	// Entry point for a Spark application bundled as a '.jar' file. This is applicable only for Java or Scala
	// applications.
	Class *string `json:"class,omitempty"`

	// An array of arguments to be passed to the application.
	Arguments []string `json:"arguments,omitempty"`

	// Application configurations to override the value specified at instance level. See [Spark environment variables](
	// https://spark.apache.org/docs/latest/configuration.html#available-properties) for a list of the supported variables.
	Conf map[string]interface{} `json:"conf,omitempty"`

	// Application environment configurations to use. See [Spark environment
	// variables](https://spark.apache.org/docs/latest/configuration.html#environment-variables) for a list of the
	// supported variables.
	Env map[string]interface{} `json:"env,omitempty"`
}

ApplicationDetails : Application details.

type ApplicationGetResponse 

type ApplicationGetResponse struct {
	// Application details.
	ApplicationDetails *ApplicationDetails `json:"application_details,omitempty"`

	// Application ID.
	ID *string `json:"id,omitempty"`

	// Identifier provided by Apache Spark for the application.
	SparkApplicationID *string `json:"spark_application_id,omitempty"`

	// Name of the Spark application.
	SparkApplicationName *string `json:"spark_application_name,omitempty"`

	// State of the Spark application.
	State *string `json:"state,omitempty"`

	// URL of the Apache Spark web UI that is available when the application is running.
	SparkUi *string `json:"spark_ui,omitempty"`

	// List of additional information messages on the current state of the application.
	StateDetails []ApplicationGetResponseStateDetailsItem `json:"state_details,omitempty"`

	// Time when the application was submitted.
	SubmissionTime *strfmt.DateTime `json:"submission_time,omitempty"`

	// Time when the application started, in the format YYYY-MM-DDTHH:mm:ssZ.
	StartTime *strfmt.DateTime `json:"start_time,omitempty"`

	// Time when the application ended either in success or failure, in the format YYYY-MM-DDTHH:mm:ssZ.
	EndTime *strfmt.DateTime `json:"end_time,omitempty"`

	// (deprecated) Time when the application completed successfully, in the format YYYY-MM-DDTHH:mm:ssZ.
	// Deprecated: this field is deprecated and may be removed in a future release.
	FinishTime *strfmt.DateTime `json:"finish_time,omitempty"`

	// Time when the application will be automatically stopped by the service.
	AutoTerminationTime *strfmt.DateTime `json:"auto_termination_time,omitempty"`
}

ApplicationGetResponse : Response of the Application Get API.

type ApplicationGetResponseStateDetailsItem 

type ApplicationGetResponseStateDetailsItem struct {
	// Type of the message.
	Type *string `json:"type,omitempty"`

	// Fixed code for the message.
	Code *string `json:"code,omitempty"`

	// A descriptive message providing additional information on the current application state.
	Message *string `json:"message,omitempty"`
}

ApplicationGetResponseStateDetailsItem : Additional information message on the current state of the application.

type ApplicationGetStateResponse 

type ApplicationGetStateResponse struct {
	// Identifier of the application.
	ID *string `json:"id,omitempty"`

	// State of the Spark application.
	State *string `json:"state,omitempty"`

	// Time when the application was started.
	StartTime *strfmt.DateTime `json:"start_time,omitempty"`

	// Time when the application run ended in success, failure or was stopped.
	EndTime *strfmt.DateTime `json:"end_time,omitempty"`

	// (deprecated) Time when the application was completed.
	// Deprecated: this field is deprecated and may be removed in a future release.
	FinishTime *strfmt.DateTime `json:"finish_time,omitempty"`

	// Time when the application will be automatically stopped by the service.
	AutoTerminationTime *strfmt.DateTime `json:"auto_termination_time,omitempty"`
}

ApplicationGetStateResponse : State of a given application.

type ApplicationResponse 

type ApplicationResponse struct {
	// Identifier of the application that was submitted.
	ID *string `json:"id,omitempty"`

	// State of the Spark application.
	State *string `json:"state,omitempty"`
}

ApplicationResponse : Application response details.

type ApplicationsPager added in v2.2.0 

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

ApplicationsPager can be used to simplify the use of the "ListApplications" method.

func (*ApplicationsPager) GetAll added in v2.2.0 

func (pager *ApplicationsPager) GetAll() (allItems []Application, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*ApplicationsPager) GetAllWithContext added in v2.2.0 

func (pager *ApplicationsPager) GetAllWithContext(ctx context.Context) (allItems []Application, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*ApplicationsPager) GetNext added in v2.2.0 

func (pager *ApplicationsPager) GetNext() (page []Application, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*ApplicationsPager) GetNextWithContext added in v2.2.0 

func (pager *ApplicationsPager) GetNextWithContext(ctx context.Context) (page []Application, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*ApplicationsPager) HasNext added in v2.2.0 

func (pager *ApplicationsPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type ConfigurePlatformLoggingOptions 

type ConfigurePlatformLoggingOptions struct {
	// GUID of the instance details for which log forwarding is to be configured.
	InstanceGuid *string `json:"instance_guid" validate:"required,ne="`

	// Enable or disable log forwarding.
	Enable *bool `json:"enable,omitempty"`

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

ConfigurePlatformLoggingOptions : The ConfigurePlatformLogging options.

func (*ConfigurePlatformLoggingOptions) SetEnable 

func (_options *ConfigurePlatformLoggingOptions) SetEnable(enable bool) *ConfigurePlatformLoggingOptions

SetEnable : Allow user to set Enable

func (*ConfigurePlatformLoggingOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ConfigurePlatformLoggingOptions) SetInstanceGuid 

func (_options *ConfigurePlatformLoggingOptions) SetInstanceGuid(instanceGuid string) *ConfigurePlatformLoggingOptions

SetInstanceGuid : Allow user to set InstanceGuid

type CreateApplicationOptions 

type CreateApplicationOptions struct {
	// The identifier of the Analytics Engine instance associated with the Spark application(s).
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Path of the application to run.
	Application *string `json:"application,omitempty"`

	// Runtime enviroment for applications and other workloads.
	Runtime *Runtime `json:"runtime,omitempty"`

	// Path of the jar files containing the application.
	Jars *string `json:"jars,omitempty"`

	// Package names.
	Packages *string `json:"packages,omitempty"`

	// Repositories names.
	Repositories *string `json:"repositories,omitempty"`

	// File names.
	Files *string `json:"files,omitempty"`

	// Archive Names.
	Archives *string `json:"archives,omitempty"`

	// Name of the application.
	Name *string `json:"name,omitempty"`

	// Entry point for a Spark application bundled as a '.jar' file. This is applicable only for Java or Scala
	// applications.
	Class *string `json:"class,omitempty"`

	// An array of arguments to be passed to the application.
	Arguments []string `json:"arguments,omitempty"`

	// Application configurations to override the value specified at instance level. See [Spark environment variables](
	// https://spark.apache.org/docs/latest/configuration.html#available-properties) for a list of the supported variables.
	Conf map[string]interface{} `json:"conf,omitempty"`

	// Application environment configurations to use. See [Spark environment
	// variables](https://spark.apache.org/docs/latest/configuration.html#environment-variables) for a list of the
	// supported variables.
	Env map[string]interface{} `json:"env,omitempty"`

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

CreateApplicationOptions : The CreateApplication options.

func (*CreateApplicationOptions) SetApplication 

func (_options *CreateApplicationOptions) SetApplication(application string) *CreateApplicationOptions

SetApplication : Allow user to set Application

func (*CreateApplicationOptions) SetArchives 

func (_options *CreateApplicationOptions) SetArchives(archives string) *CreateApplicationOptions

SetArchives : Allow user to set Archives

func (*CreateApplicationOptions) SetArguments 

func (_options *CreateApplicationOptions) SetArguments(arguments []string) *CreateApplicationOptions

SetArguments : Allow user to set Arguments

func (*CreateApplicationOptions) SetClass 

func (_options *CreateApplicationOptions) SetClass(class string) *CreateApplicationOptions

SetClass : Allow user to set Class

func (*CreateApplicationOptions) SetConf 

func (_options *CreateApplicationOptions) SetConf(conf map[string]interface{}) *CreateApplicationOptions

SetConf : Allow user to set Conf

func (*CreateApplicationOptions) SetEnv 

func (_options *CreateApplicationOptions) SetEnv(env map[string]interface{}) *CreateApplicationOptions

SetEnv : Allow user to set Env

func (*CreateApplicationOptions) SetFiles 

func (_options *CreateApplicationOptions) SetFiles(files string) *CreateApplicationOptions

SetFiles : Allow user to set Files

func (*CreateApplicationOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreateApplicationOptions) SetInstanceID 

func (_options *CreateApplicationOptions) SetInstanceID(instanceID string) *CreateApplicationOptions

SetInstanceID : Allow user to set InstanceID

func (*CreateApplicationOptions) SetJars 

func (_options *CreateApplicationOptions) SetJars(jars string) *CreateApplicationOptions

SetJars : Allow user to set Jars

func (*CreateApplicationOptions) SetName 

func (_options *CreateApplicationOptions) SetName(name string) *CreateApplicationOptions

SetName : Allow user to set Name

func (*CreateApplicationOptions) SetPackages 

func (_options *CreateApplicationOptions) SetPackages(packages string) *CreateApplicationOptions

SetPackages : Allow user to set Packages

func (*CreateApplicationOptions) SetRepositories 

func (_options *CreateApplicationOptions) SetRepositories(repositories string) *CreateApplicationOptions

SetRepositories : Allow user to set Repositories

func (*CreateApplicationOptions) SetRuntime 

func (_options *CreateApplicationOptions) SetRuntime(runtime *Runtime) *CreateApplicationOptions

SetRuntime : Allow user to set Runtime

type CurrentResourceConsumptionResponse 

type CurrentResourceConsumptionResponse struct {
	// Number of virtual processor cores used.
	Cores *string `json:"cores,omitempty"`

	// Amount of memory used.
	Memory *string `json:"memory,omitempty"`
}

CurrentResourceConsumptionResponse : Current resource consumption of the instance.

type DeleteApplicationOptions 

type DeleteApplicationOptions struct {
	// Identifier of the instance to which the application belongs.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Identifier of the application that needs to be stopped.
	ApplicationID *string `json:"application_id" validate:"required,ne="`

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

DeleteApplicationOptions : The DeleteApplication options.

func (*DeleteApplicationOptions) SetApplicationID 

func (_options *DeleteApplicationOptions) SetApplicationID(applicationID string) *DeleteApplicationOptions

SetApplicationID : Allow user to set ApplicationID

func (*DeleteApplicationOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*DeleteApplicationOptions) SetInstanceID 

func (_options *DeleteApplicationOptions) SetInstanceID(instanceID string) *DeleteApplicationOptions

SetInstanceID : Allow user to set InstanceID

type GetApplicationOptions 

type GetApplicationOptions struct {
	// Identifier of the instance to which the application belongs.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Identifier of the application for which details are requested.
	ApplicationID *string `json:"application_id" validate:"required,ne="`

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

GetApplicationOptions : The GetApplication options.

func (*GetApplicationOptions) SetApplicationID 

func (_options *GetApplicationOptions) SetApplicationID(applicationID string) *GetApplicationOptions

SetApplicationID : Allow user to set ApplicationID

func (*GetApplicationOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetApplicationOptions) SetInstanceID 

func (_options *GetApplicationOptions) SetInstanceID(instanceID string) *GetApplicationOptions

SetInstanceID : Allow user to set InstanceID

type GetApplicationStateOptions 

type GetApplicationStateOptions struct {
	// Identifier of the instance to which the applications belongs.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Identifier of the application for which details are requested.
	ApplicationID *string `json:"application_id" validate:"required,ne="`

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

GetApplicationStateOptions : The GetApplicationState options.

func (*GetApplicationStateOptions) SetApplicationID 

func (_options *GetApplicationStateOptions) SetApplicationID(applicationID string) *GetApplicationStateOptions

SetApplicationID : Allow user to set ApplicationID

func (*GetApplicationStateOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetApplicationStateOptions) SetInstanceID 

func (_options *GetApplicationStateOptions) SetInstanceID(instanceID string) *GetApplicationStateOptions

SetInstanceID : Allow user to set InstanceID

type GetCurrentResourceConsumptionOptions 

type GetCurrentResourceConsumptionOptions struct {
	// ID of the Analytics Engine instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

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

GetCurrentResourceConsumptionOptions : The GetCurrentResourceConsumption options.

func (*GetCurrentResourceConsumptionOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetCurrentResourceConsumptionOptions) SetInstanceID 

func (_options *GetCurrentResourceConsumptionOptions) SetInstanceID(instanceID string) *GetCurrentResourceConsumptionOptions

SetInstanceID : Allow user to set InstanceID

type GetInstanceDefaultConfigsOptions 

type GetInstanceDefaultConfigsOptions struct {
	// The ID of the Analytics Engine instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

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

GetInstanceDefaultConfigsOptions : The GetInstanceDefaultConfigs options.

func (*GetInstanceDefaultConfigsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetInstanceDefaultConfigsOptions) SetInstanceID 

func (_options *GetInstanceDefaultConfigsOptions) SetInstanceID(instanceID string) *GetInstanceDefaultConfigsOptions

SetInstanceID : Allow user to set InstanceID

type GetInstanceDefaultRuntimeOptions 

type GetInstanceDefaultRuntimeOptions struct {
	// The ID of the Analytics Engine instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

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

GetInstanceDefaultRuntimeOptions : The GetInstanceDefaultRuntime options.

func (*GetInstanceDefaultRuntimeOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetInstanceDefaultRuntimeOptions) SetInstanceID 

func (_options *GetInstanceDefaultRuntimeOptions) SetInstanceID(instanceID string) *GetInstanceDefaultRuntimeOptions

SetInstanceID : Allow user to set InstanceID

type GetInstanceOptions 

type GetInstanceOptions struct {
	// GUID of the Analytics Engine service instance to retrieve.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

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

GetInstanceOptions : The GetInstance options.

func (*GetInstanceOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetInstanceOptions) SetInstanceID 

func (_options *GetInstanceOptions) SetInstanceID(instanceID string) *GetInstanceOptions

SetInstanceID : Allow user to set InstanceID

type GetInstanceStateOptions 

type GetInstanceStateOptions struct {
	// GUID of the Analytics Engine service instance to retrieve state.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

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

GetInstanceStateOptions : The GetInstanceState options.

func (*GetInstanceStateOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetInstanceStateOptions) SetInstanceID 

func (_options *GetInstanceStateOptions) SetInstanceID(instanceID string) *GetInstanceStateOptions

SetInstanceID : Allow user to set InstanceID

type GetLogForwardingConfigOptions 

type GetLogForwardingConfigOptions struct {
	// ID of the Analytics Engine instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

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

GetLogForwardingConfigOptions : The GetLogForwardingConfig options.

func (*GetLogForwardingConfigOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetLogForwardingConfigOptions) SetInstanceID 

func (_options *GetLogForwardingConfigOptions) SetInstanceID(instanceID string) *GetLogForwardingConfigOptions

SetInstanceID : Allow user to set InstanceID

type GetLoggingConfigurationOptions 

type GetLoggingConfigurationOptions struct {
	// GUID of the Analytics Engine service instance to retrieve log configuration.
	InstanceGuid *string `json:"instance_guid" validate:"required,ne="`

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

GetLoggingConfigurationOptions : The GetLoggingConfiguration options.

func (*GetLoggingConfigurationOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetLoggingConfigurationOptions) SetInstanceGuid 

func (_options *GetLoggingConfigurationOptions) SetInstanceGuid(instanceGuid string) *GetLoggingConfigurationOptions

SetInstanceGuid : Allow user to set InstanceGuid

type GetResourceConsumptionLimitsOptions 

type GetResourceConsumptionLimitsOptions struct {
	// ID of the Analytics Engine instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

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

GetResourceConsumptionLimitsOptions : The GetResourceConsumptionLimits options.

func (*GetResourceConsumptionLimitsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetResourceConsumptionLimitsOptions) SetInstanceID 

func (_options *GetResourceConsumptionLimitsOptions) SetInstanceID(instanceID string) *GetResourceConsumptionLimitsOptions

SetInstanceID : Allow user to set InstanceID

type GetSparkHistoryServerOptions 

type GetSparkHistoryServerOptions struct {
	// The ID of the Analytics Engine instance to which the Spark history server belongs.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

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

GetSparkHistoryServerOptions : The GetSparkHistoryServer options.

func (*GetSparkHistoryServerOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetSparkHistoryServerOptions) SetInstanceID 

func (_options *GetSparkHistoryServerOptions) SetInstanceID(instanceID string) *GetSparkHistoryServerOptions

SetInstanceID : Allow user to set InstanceID

type IbmAnalyticsEngineApiV3 

type IbmAnalyticsEngineApiV3 struct {
	Service *core.BaseService
}

IbmAnalyticsEngineApiV3 : Manage serverless Spark instances and run applications.

API Version: 3.0.0

func NewIbmAnalyticsEngineApiV3 

func NewIbmAnalyticsEngineApiV3(options *IbmAnalyticsEngineApiV3Options) (service *IbmAnalyticsEngineApiV3, err error)

NewIbmAnalyticsEngineApiV3 : constructs an instance of IbmAnalyticsEngineApiV3 with passed in options.

func NewIbmAnalyticsEngineApiV3UsingExternalConfig 

func NewIbmAnalyticsEngineApiV3UsingExternalConfig(options *IbmAnalyticsEngineApiV3Options) (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3, err error)

NewIbmAnalyticsEngineApiV3UsingExternalConfig : constructs an instance of IbmAnalyticsEngineApiV3 with passed in options and external configuration.

func (*IbmAnalyticsEngineApiV3) Clone 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) Clone() *IbmAnalyticsEngineApiV3

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

func (*IbmAnalyticsEngineApiV3) ConfigurePlatformLogging 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) ConfigurePlatformLogging(configurePlatformLoggingOptions *ConfigurePlatformLoggingOptions) (result *LoggingConfigurationResponse, response *core.DetailedResponse, err error)

ConfigurePlatformLogging : Enable or disable log forwarding Enable or disable log forwarding from IBM Analytics Engine to IBM Log Analysis server. *Note:* Deprecated. Use the log forwarding config api instead. Deprecated: this method is deprecated and may be removed in a future release.

func (*IbmAnalyticsEngineApiV3) ConfigurePlatformLoggingWithContext 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) ConfigurePlatformLoggingWithContext(ctx context.Context, configurePlatformLoggingOptions *ConfigurePlatformLoggingOptions) (result *LoggingConfigurationResponse, response *core.DetailedResponse, err error)

ConfigurePlatformLoggingWithContext is an alternate form of the ConfigurePlatformLogging method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*IbmAnalyticsEngineApiV3) CreateApplication 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) CreateApplication(createApplicationOptions *CreateApplicationOptions) (result *ApplicationResponse, response *core.DetailedResponse, err error)

CreateApplication : Deploy a Spark application Deploys a Spark application on a given serverless Spark instance.

func (*IbmAnalyticsEngineApiV3) CreateApplicationWithContext 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) CreateApplicationWithContext(ctx context.Context, createApplicationOptions *CreateApplicationOptions) (result *ApplicationResponse, response *core.DetailedResponse, err error)

CreateApplicationWithContext is an alternate form of the CreateApplication method which supports a Context parameter

func (*IbmAnalyticsEngineApiV3) DeleteApplication 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) DeleteApplication(deleteApplicationOptions *DeleteApplicationOptions) (response *core.DetailedResponse, err error)

DeleteApplication : Stop application Stops a running application identified by the app_id identifier. This is an idempotent operation. Performs no action if the requested application is already stopped or completed.

func (*IbmAnalyticsEngineApiV3) DeleteApplicationWithContext 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) DeleteApplicationWithContext(ctx context.Context, deleteApplicationOptions *DeleteApplicationOptions) (response *core.DetailedResponse, err error)

DeleteApplicationWithContext is an alternate form of the DeleteApplication method which supports a Context parameter

func (*IbmAnalyticsEngineApiV3) DisableRetries 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) DisableRetries()

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

func (*IbmAnalyticsEngineApiV3) EnableRetries 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) 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 (*IbmAnalyticsEngineApiV3) GetApplication 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetApplication(getApplicationOptions *GetApplicationOptions) (result *ApplicationGetResponse, response *core.DetailedResponse, err error)

GetApplication : Retrieve the details of a given Spark application Gets the details of a given Spark application.

func (*IbmAnalyticsEngineApiV3) GetApplicationState 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetApplicationState(getApplicationStateOptions *GetApplicationStateOptions) (result *ApplicationGetStateResponse, response *core.DetailedResponse, err error)

GetApplicationState : Get the status of the application Returns the status of the given Spark application.

func (*IbmAnalyticsEngineApiV3) GetApplicationStateWithContext 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetApplicationStateWithContext(ctx context.Context, getApplicationStateOptions *GetApplicationStateOptions) (result *ApplicationGetStateResponse, response *core.DetailedResponse, err error)

GetApplicationStateWithContext is an alternate form of the GetApplicationState method which supports a Context parameter

func (*IbmAnalyticsEngineApiV3) GetApplicationWithContext 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetApplicationWithContext(ctx context.Context, getApplicationOptions *GetApplicationOptions) (result *ApplicationGetResponse, response *core.DetailedResponse, err error)

GetApplicationWithContext is an alternate form of the GetApplication method which supports a Context parameter

func (*IbmAnalyticsEngineApiV3) GetCurrentResourceConsumption 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetCurrentResourceConsumption(getCurrentResourceConsumptionOptions *GetCurrentResourceConsumptionOptions) (result *CurrentResourceConsumptionResponse, response *core.DetailedResponse, err error)

GetCurrentResourceConsumption : Get current resource consumption Gives the total memory and virtual processor cores allotted to all the applications running in the service instance at this point in time. When auto-scaled applications are running, the resources allotted will change over time, based on the applications's demands. Note: The consumption is not an indication of actual resource consumption by Spark processes. It is the sum of resources allocated to the currently running applications at the time of application submission.

func (*IbmAnalyticsEngineApiV3) GetCurrentResourceConsumptionWithContext 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetCurrentResourceConsumptionWithContext(ctx context.Context, getCurrentResourceConsumptionOptions *GetCurrentResourceConsumptionOptions) (result *CurrentResourceConsumptionResponse, response *core.DetailedResponse, err error)

GetCurrentResourceConsumptionWithContext is an alternate form of the GetCurrentResourceConsumption method which supports a Context parameter

func (*IbmAnalyticsEngineApiV3) GetEnableGzipCompression 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*IbmAnalyticsEngineApiV3) GetInstance 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetInstance(getInstanceOptions *GetInstanceOptions) (result *Instance, response *core.DetailedResponse, err error)

GetInstance : Find Analytics Engine by id Retrieve the details of a single Analytics Engine instance.

func (*IbmAnalyticsEngineApiV3) GetInstanceDefaultConfigs 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetInstanceDefaultConfigs(getInstanceDefaultConfigsOptions *GetInstanceDefaultConfigsOptions) (result map[string]string, response *core.DetailedResponse, err error)

GetInstanceDefaultConfigs : Get instance default Spark configurations Get the default Spark configuration properties that will be applied to all applications of the instance.

func (*IbmAnalyticsEngineApiV3) GetInstanceDefaultConfigsWithContext 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetInstanceDefaultConfigsWithContext(ctx context.Context, getInstanceDefaultConfigsOptions *GetInstanceDefaultConfigsOptions) (result map[string]string, response *core.DetailedResponse, err error)

GetInstanceDefaultConfigsWithContext is an alternate form of the GetInstanceDefaultConfigs method which supports a Context parameter

func (*IbmAnalyticsEngineApiV3) GetInstanceDefaultRuntime 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetInstanceDefaultRuntime(getInstanceDefaultRuntimeOptions *GetInstanceDefaultRuntimeOptions) (result *Runtime, response *core.DetailedResponse, err error)

GetInstanceDefaultRuntime : Get instance default runtime Get the default runtime environment on which all workloads of the instance will run.

func (*IbmAnalyticsEngineApiV3) GetInstanceDefaultRuntimeWithContext 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetInstanceDefaultRuntimeWithContext(ctx context.Context, getInstanceDefaultRuntimeOptions *GetInstanceDefaultRuntimeOptions) (result *Runtime, response *core.DetailedResponse, err error)

GetInstanceDefaultRuntimeWithContext is an alternate form of the GetInstanceDefaultRuntime method which supports a Context parameter

func (*IbmAnalyticsEngineApiV3) GetInstanceState 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetInstanceState(getInstanceStateOptions *GetInstanceStateOptions) (result *InstanceGetStateResponse, response *core.DetailedResponse, err error)

GetInstanceState : Find Analytics Engine state by id Retrieve the state of a single Analytics Engine instance.

func (*IbmAnalyticsEngineApiV3) GetInstanceStateWithContext 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetInstanceStateWithContext(ctx context.Context, getInstanceStateOptions *GetInstanceStateOptions) (result *InstanceGetStateResponse, response *core.DetailedResponse, err error)

GetInstanceStateWithContext is an alternate form of the GetInstanceState method which supports a Context parameter

func (*IbmAnalyticsEngineApiV3) GetInstanceWithContext 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetInstanceWithContext(ctx context.Context, getInstanceOptions *GetInstanceOptions) (result *Instance, response *core.DetailedResponse, err error)

GetInstanceWithContext is an alternate form of the GetInstance method which supports a Context parameter

func (*IbmAnalyticsEngineApiV3) GetLogForwardingConfig 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetLogForwardingConfig(getLogForwardingConfigOptions *GetLogForwardingConfigOptions) (result *LogForwardingConfigResponse, response *core.DetailedResponse, err error)

GetLogForwardingConfig : Get log forwarding configuration Retrieve the log forwarding configuration of the Analytics Engine instance.

func (*IbmAnalyticsEngineApiV3) GetLogForwardingConfigWithContext 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetLogForwardingConfigWithContext(ctx context.Context, getLogForwardingConfigOptions *GetLogForwardingConfigOptions) (result *LogForwardingConfigResponse, response *core.DetailedResponse, err error)

GetLogForwardingConfigWithContext is an alternate form of the GetLogForwardingConfig method which supports a Context parameter

func (*IbmAnalyticsEngineApiV3) GetLoggingConfiguration 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetLoggingConfiguration(getLoggingConfigurationOptions *GetLoggingConfigurationOptions) (result *LoggingConfigurationResponse, response *core.DetailedResponse, err error)

GetLoggingConfiguration : Retrieve the logging configuration for a given instance id Retrieve the logging configuration of a given Analytics Engine instance. *Note:* Deprecated. Use the log forwarding config api instead. Deprecated: this method is deprecated and may be removed in a future release.

func (*IbmAnalyticsEngineApiV3) GetLoggingConfigurationWithContext 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetLoggingConfigurationWithContext(ctx context.Context, getLoggingConfigurationOptions *GetLoggingConfigurationOptions) (result *LoggingConfigurationResponse, response *core.DetailedResponse, err error)

GetLoggingConfigurationWithContext is an alternate form of the GetLoggingConfiguration method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*IbmAnalyticsEngineApiV3) GetResourceConsumptionLimits 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetResourceConsumptionLimits(getResourceConsumptionLimitsOptions *GetResourceConsumptionLimitsOptions) (result *ResourceConsumptionLimitsResponse, response *core.DetailedResponse, err error)

GetResourceConsumptionLimits : Get resource consumption limits Returns the maximum total memory and virtual processor cores that can be allotted across all the applications running in the service instance at any point in time.

func (*IbmAnalyticsEngineApiV3) GetResourceConsumptionLimitsWithContext 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetResourceConsumptionLimitsWithContext(ctx context.Context, getResourceConsumptionLimitsOptions *GetResourceConsumptionLimitsOptions) (result *ResourceConsumptionLimitsResponse, response *core.DetailedResponse, err error)

GetResourceConsumptionLimitsWithContext is an alternate form of the GetResourceConsumptionLimits method which supports a Context parameter

func (*IbmAnalyticsEngineApiV3) GetServiceURL 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetServiceURL() string

GetServiceURL returns the service URL

func (*IbmAnalyticsEngineApiV3) GetSparkHistoryServer 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetSparkHistoryServer(getSparkHistoryServerOptions *GetSparkHistoryServerOptions) (result *SparkHistoryServerResponse, response *core.DetailedResponse, err error)

GetSparkHistoryServer : Get Spark history server details Get the details of the Spark history server of the given Analytics Engine instance.

func (*IbmAnalyticsEngineApiV3) GetSparkHistoryServerWithContext 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetSparkHistoryServerWithContext(ctx context.Context, getSparkHistoryServerOptions *GetSparkHistoryServerOptions) (result *SparkHistoryServerResponse, response *core.DetailedResponse, err error)

GetSparkHistoryServerWithContext is an alternate form of the GetSparkHistoryServer method which supports a Context parameter

func (*IbmAnalyticsEngineApiV3) ListApplications 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) ListApplications(listApplicationsOptions *ListApplicationsOptions) (result *ApplicationCollection, response *core.DetailedResponse, err error)

ListApplications : List all Spark applications Returns a list of all Spark applications submitted to the specified Analytics Engine instance. The result can be filtered by specifying query parameters.

func (*IbmAnalyticsEngineApiV3) ListApplicationsWithContext 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) ListApplicationsWithContext(ctx context.Context, listApplicationsOptions *ListApplicationsOptions) (result *ApplicationCollection, response *core.DetailedResponse, err error)

ListApplicationsWithContext is an alternate form of the ListApplications method which supports a Context parameter

func (*IbmAnalyticsEngineApiV3) NewApplicationsPager added in v2.2.0 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) NewApplicationsPager(options *ListApplicationsOptions) (pager *ApplicationsPager, err error)

NewApplicationsPager returns a new ApplicationsPager instance.

func (*IbmAnalyticsEngineApiV3) NewConfigurePlatformLoggingOptions 

func (*IbmAnalyticsEngineApiV3) NewConfigurePlatformLoggingOptions(instanceGuid string) *ConfigurePlatformLoggingOptions

NewConfigurePlatformLoggingOptions : Instantiate ConfigurePlatformLoggingOptions

func (*IbmAnalyticsEngineApiV3) NewCreateApplicationOptions 

func (*IbmAnalyticsEngineApiV3) NewCreateApplicationOptions(instanceID string) *CreateApplicationOptions

NewCreateApplicationOptions : Instantiate CreateApplicationOptions

func (*IbmAnalyticsEngineApiV3) NewDeleteApplicationOptions 

func (*IbmAnalyticsEngineApiV3) NewDeleteApplicationOptions(instanceID string, applicationID string) *DeleteApplicationOptions

NewDeleteApplicationOptions : Instantiate DeleteApplicationOptions

func (*IbmAnalyticsEngineApiV3) NewGetApplicationOptions 

func (*IbmAnalyticsEngineApiV3) NewGetApplicationOptions(instanceID string, applicationID string) *GetApplicationOptions

NewGetApplicationOptions : Instantiate GetApplicationOptions

func (*IbmAnalyticsEngineApiV3) NewGetApplicationStateOptions 

func (*IbmAnalyticsEngineApiV3) NewGetApplicationStateOptions(instanceID string, applicationID string) *GetApplicationStateOptions

NewGetApplicationStateOptions : Instantiate GetApplicationStateOptions

func (*IbmAnalyticsEngineApiV3) NewGetCurrentResourceConsumptionOptions 

func (*IbmAnalyticsEngineApiV3) NewGetCurrentResourceConsumptionOptions(instanceID string) *GetCurrentResourceConsumptionOptions

NewGetCurrentResourceConsumptionOptions : Instantiate GetCurrentResourceConsumptionOptions

func (*IbmAnalyticsEngineApiV3) NewGetInstanceDefaultConfigsOptions 

func (*IbmAnalyticsEngineApiV3) NewGetInstanceDefaultConfigsOptions(instanceID string) *GetInstanceDefaultConfigsOptions

NewGetInstanceDefaultConfigsOptions : Instantiate GetInstanceDefaultConfigsOptions

func (*IbmAnalyticsEngineApiV3) NewGetInstanceDefaultRuntimeOptions 

func (*IbmAnalyticsEngineApiV3) NewGetInstanceDefaultRuntimeOptions(instanceID string) *GetInstanceDefaultRuntimeOptions

NewGetInstanceDefaultRuntimeOptions : Instantiate GetInstanceDefaultRuntimeOptions

func (*IbmAnalyticsEngineApiV3) NewGetInstanceOptions 

func (*IbmAnalyticsEngineApiV3) NewGetInstanceOptions(instanceID string) *GetInstanceOptions

NewGetInstanceOptions : Instantiate GetInstanceOptions

func (*IbmAnalyticsEngineApiV3) NewGetInstanceStateOptions 

func (*IbmAnalyticsEngineApiV3) NewGetInstanceStateOptions(instanceID string) *GetInstanceStateOptions

NewGetInstanceStateOptions : Instantiate GetInstanceStateOptions

func (*IbmAnalyticsEngineApiV3) NewGetLogForwardingConfigOptions 

func (*IbmAnalyticsEngineApiV3) NewGetLogForwardingConfigOptions(instanceID string) *GetLogForwardingConfigOptions

NewGetLogForwardingConfigOptions : Instantiate GetLogForwardingConfigOptions

func (*IbmAnalyticsEngineApiV3) NewGetLoggingConfigurationOptions 

func (*IbmAnalyticsEngineApiV3) NewGetLoggingConfigurationOptions(instanceGuid string) *GetLoggingConfigurationOptions

NewGetLoggingConfigurationOptions : Instantiate GetLoggingConfigurationOptions

func (*IbmAnalyticsEngineApiV3) NewGetResourceConsumptionLimitsOptions 

func (*IbmAnalyticsEngineApiV3) NewGetResourceConsumptionLimitsOptions(instanceID string) *GetResourceConsumptionLimitsOptions

NewGetResourceConsumptionLimitsOptions : Instantiate GetResourceConsumptionLimitsOptions

func (*IbmAnalyticsEngineApiV3) NewGetSparkHistoryServerOptions 

func (*IbmAnalyticsEngineApiV3) NewGetSparkHistoryServerOptions(instanceID string) *GetSparkHistoryServerOptions

NewGetSparkHistoryServerOptions : Instantiate GetSparkHistoryServerOptions

func (*IbmAnalyticsEngineApiV3) NewListApplicationsOptions 

func (*IbmAnalyticsEngineApiV3) NewListApplicationsOptions(instanceID string) *ListApplicationsOptions

NewListApplicationsOptions : Instantiate ListApplicationsOptions

func (*IbmAnalyticsEngineApiV3) NewReplaceInstanceDefaultConfigsOptions 

func (*IbmAnalyticsEngineApiV3) NewReplaceInstanceDefaultConfigsOptions(instanceID string, body map[string]string) *ReplaceInstanceDefaultConfigsOptions

NewReplaceInstanceDefaultConfigsOptions : Instantiate ReplaceInstanceDefaultConfigsOptions

func (*IbmAnalyticsEngineApiV3) NewReplaceInstanceDefaultRuntimeOptions 

func (*IbmAnalyticsEngineApiV3) NewReplaceInstanceDefaultRuntimeOptions(instanceID string) *ReplaceInstanceDefaultRuntimeOptions

NewReplaceInstanceDefaultRuntimeOptions : Instantiate ReplaceInstanceDefaultRuntimeOptions

func (*IbmAnalyticsEngineApiV3) NewReplaceLogForwardingConfigOptions 

func (*IbmAnalyticsEngineApiV3) NewReplaceLogForwardingConfigOptions(instanceID string) *ReplaceLogForwardingConfigOptions

NewReplaceLogForwardingConfigOptions : Instantiate ReplaceLogForwardingConfigOptions

func (*IbmAnalyticsEngineApiV3) NewSetInstanceHomeOptions 

func (*IbmAnalyticsEngineApiV3) NewSetInstanceHomeOptions(instanceID string) *SetInstanceHomeOptions

NewSetInstanceHomeOptions : Instantiate SetInstanceHomeOptions

func (*IbmAnalyticsEngineApiV3) NewStartSparkHistoryServerOptions 

func (*IbmAnalyticsEngineApiV3) NewStartSparkHistoryServerOptions(instanceID string) *StartSparkHistoryServerOptions

NewStartSparkHistoryServerOptions : Instantiate StartSparkHistoryServerOptions

func (*IbmAnalyticsEngineApiV3) NewStopSparkHistoryServerOptions 

func (*IbmAnalyticsEngineApiV3) NewStopSparkHistoryServerOptions(instanceID string) *StopSparkHistoryServerOptions

NewStopSparkHistoryServerOptions : Instantiate StopSparkHistoryServerOptions

func (*IbmAnalyticsEngineApiV3) NewUpdateInstanceDefaultConfigsOptions 

func (*IbmAnalyticsEngineApiV3) NewUpdateInstanceDefaultConfigsOptions(instanceID string, body map[string]interface{}) *UpdateInstanceDefaultConfigsOptions

NewUpdateInstanceDefaultConfigsOptions : Instantiate UpdateInstanceDefaultConfigsOptions

func (*IbmAnalyticsEngineApiV3) NewUpdateInstanceHomeCredentialsOptions added in v2.1.0 

func (*IbmAnalyticsEngineApiV3) NewUpdateInstanceHomeCredentialsOptions(instanceID string, hmacAccessKey string, hmacSecretKey string) *UpdateInstanceHomeCredentialsOptions

NewUpdateInstanceHomeCredentialsOptions : Instantiate UpdateInstanceHomeCredentialsOptions

func (*IbmAnalyticsEngineApiV3) ReplaceInstanceDefaultConfigs 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) ReplaceInstanceDefaultConfigs(replaceInstanceDefaultConfigsOptions *ReplaceInstanceDefaultConfigsOptions) (result map[string]string, response *core.DetailedResponse, err error)

ReplaceInstanceDefaultConfigs : Replace instance default Spark configurations Replace the default Spark configuration properties that will be applied to all applications of the instance.

func (*IbmAnalyticsEngineApiV3) ReplaceInstanceDefaultConfigsWithContext 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) ReplaceInstanceDefaultConfigsWithContext(ctx context.Context, replaceInstanceDefaultConfigsOptions *ReplaceInstanceDefaultConfigsOptions) (result map[string]string, response *core.DetailedResponse, err error)

ReplaceInstanceDefaultConfigsWithContext is an alternate form of the ReplaceInstanceDefaultConfigs method which supports a Context parameter

func (*IbmAnalyticsEngineApiV3) ReplaceInstanceDefaultRuntime 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) ReplaceInstanceDefaultRuntime(replaceInstanceDefaultRuntimeOptions *ReplaceInstanceDefaultRuntimeOptions) (result *Runtime, response *core.DetailedResponse, err error)

ReplaceInstanceDefaultRuntime : Replace instance default runtime Replace the default runtime environment on which all workloads of the instance will run.

func (*IbmAnalyticsEngineApiV3) ReplaceInstanceDefaultRuntimeWithContext 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) ReplaceInstanceDefaultRuntimeWithContext(ctx context.Context, replaceInstanceDefaultRuntimeOptions *ReplaceInstanceDefaultRuntimeOptions) (result *Runtime, response *core.DetailedResponse, err error)

ReplaceInstanceDefaultRuntimeWithContext is an alternate form of the ReplaceInstanceDefaultRuntime method which supports a Context parameter

func (*IbmAnalyticsEngineApiV3) ReplaceLogForwardingConfig 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) ReplaceLogForwardingConfig(replaceLogForwardingConfigOptions *ReplaceLogForwardingConfigOptions) (result *LogForwardingConfigResponse, response *core.DetailedResponse, err error)

ReplaceLogForwardingConfig : Replace log forwarding configuration Modify the configuration for forwarding logs from the Analytics Engine instance to IBM Log Analysis server. Use this endpoint to enable or disable log forwarding.

func (*IbmAnalyticsEngineApiV3) ReplaceLogForwardingConfigWithContext 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) ReplaceLogForwardingConfigWithContext(ctx context.Context, replaceLogForwardingConfigOptions *ReplaceLogForwardingConfigOptions) (result *LogForwardingConfigResponse, response *core.DetailedResponse, err error)

ReplaceLogForwardingConfigWithContext is an alternate form of the ReplaceLogForwardingConfig method which supports a Context parameter

func (*IbmAnalyticsEngineApiV3) SetDefaultHeaders 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*IbmAnalyticsEngineApiV3) SetEnableGzipCompression 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*IbmAnalyticsEngineApiV3) SetInstanceHome 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) SetInstanceHome(setInstanceHomeOptions *SetInstanceHomeOptions) (result *InstanceHomeResponse, response *core.DetailedResponse, err error)

SetInstanceHome : Set instance home Provide the details of the Cloud Object Storage instance to associate with the Analytics Engine instance and use as 'instance home' if 'instance home' has not already been set.

**Note**: You can set 'instance home' again if the instance is in 'instance_home_creation_failure' state.

func (*IbmAnalyticsEngineApiV3) SetInstanceHomeWithContext 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) SetInstanceHomeWithContext(ctx context.Context, setInstanceHomeOptions *SetInstanceHomeOptions) (result *InstanceHomeResponse, response *core.DetailedResponse, err error)

SetInstanceHomeWithContext is an alternate form of the SetInstanceHome method which supports a Context parameter

func (*IbmAnalyticsEngineApiV3) SetServiceURL 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*IbmAnalyticsEngineApiV3) StartSparkHistoryServer 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) StartSparkHistoryServer(startSparkHistoryServerOptions *StartSparkHistoryServerOptions) (result *SparkHistoryServerResponse, response *core.DetailedResponse, err error)

StartSparkHistoryServer : Start Spark history server Start the Spark history server for the given Analytics Engine instance.

func (*IbmAnalyticsEngineApiV3) StartSparkHistoryServerWithContext 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) StartSparkHistoryServerWithContext(ctx context.Context, startSparkHistoryServerOptions *StartSparkHistoryServerOptions) (result *SparkHistoryServerResponse, response *core.DetailedResponse, err error)

StartSparkHistoryServerWithContext is an alternate form of the StartSparkHistoryServer method which supports a Context parameter

func (*IbmAnalyticsEngineApiV3) StopSparkHistoryServer 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) StopSparkHistoryServer(stopSparkHistoryServerOptions *StopSparkHistoryServerOptions) (response *core.DetailedResponse, err error)

StopSparkHistoryServer : Stop Spark history server Stop the Spark history server of the given Analytics Engine instance.

func (*IbmAnalyticsEngineApiV3) StopSparkHistoryServerWithContext 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) StopSparkHistoryServerWithContext(ctx context.Context, stopSparkHistoryServerOptions *StopSparkHistoryServerOptions) (response *core.DetailedResponse, err error)

StopSparkHistoryServerWithContext is an alternate form of the StopSparkHistoryServer method which supports a Context parameter

func (*IbmAnalyticsEngineApiV3) UpdateInstanceDefaultConfigs 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) UpdateInstanceDefaultConfigs(updateInstanceDefaultConfigsOptions *UpdateInstanceDefaultConfigsOptions) (result map[string]string, response *core.DetailedResponse, err error)

UpdateInstanceDefaultConfigs : Update instance default Spark configurations Update the default Spark configuration properties that will be applied to all applications of the instance.

func (*IbmAnalyticsEngineApiV3) UpdateInstanceDefaultConfigsWithContext 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) UpdateInstanceDefaultConfigsWithContext(ctx context.Context, updateInstanceDefaultConfigsOptions *UpdateInstanceDefaultConfigsOptions) (result map[string]string, response *core.DetailedResponse, err error)

UpdateInstanceDefaultConfigsWithContext is an alternate form of the UpdateInstanceDefaultConfigs method which supports a Context parameter

func (*IbmAnalyticsEngineApiV3) UpdateInstanceHomeCredentials added in v2.1.0 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) UpdateInstanceHomeCredentials(updateInstanceHomeCredentialsOptions *UpdateInstanceHomeCredentialsOptions) (result *InstanceHomeResponse, response *core.DetailedResponse, err error)

UpdateInstanceHomeCredentials : Update instance home credentials Update the HMAC credentials used to access the instance home, if the instance home was set earlier. Credentials must have write access to the object storage used as instance home.

**Note**: Your running applications and the Spark history server would continue to use the old credentials after updating the HMAC credentials. Before revoking the old credentials, you must either wait for them to finish running or stop them.

func (*IbmAnalyticsEngineApiV3) UpdateInstanceHomeCredentialsWithContext added in v2.1.0 

func (ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) UpdateInstanceHomeCredentialsWithContext(ctx context.Context, updateInstanceHomeCredentialsOptions *UpdateInstanceHomeCredentialsOptions) (result *InstanceHomeResponse, response *core.DetailedResponse, err error)

UpdateInstanceHomeCredentialsWithContext is an alternate form of the UpdateInstanceHomeCredentials method which supports a Context parameter

type IbmAnalyticsEngineApiV3Options 

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

IbmAnalyticsEngineApiV3Options : Service options

type Instance 

type Instance struct {
	// GUID of the Analytics Engine instance.
	ID *string `json:"id,omitempty"`

	// Full URL of the resource.
	Href *string `json:"href,omitempty"`

	// State of the Analytics Engine instance.
	State *string `json:"state,omitempty"`

	// Timestamp when the state of the instance was changed, in the format YYYY-MM-DDTHH:mm:ssZ.
	StateChangeTime *strfmt.DateTime `json:"state_change_time,omitempty"`

	// Runtime enviroment for applications and other workloads.
	DefaultRuntime *Runtime `json:"default_runtime,omitempty"`

	// Object storage instance that acts as the home for custom libraries and Spark events.
	InstanceHome *InstanceHome `json:"instance_home,omitempty"`

	// Instance level default configuration for Spark workloads.
	DefaultConfig *InstanceDefaultConfig `json:"default_config,omitempty"`
}

Instance : Details of Analytics Engine instance.

type InstanceDefaultConfig 

type InstanceDefaultConfig struct {
	// Value of the Spark configuration key.
	Key *string `json:"key,omitempty"`
}

InstanceDefaultConfig : Instance level default configuration for Spark workloads.

type InstanceGetStateResponse 

type InstanceGetStateResponse struct {
	// GUID of the Analytics Engine instance.
	ID *string `json:"id,omitempty"`

	// State of the Analytics Engine instance.
	State *string `json:"state,omitempty"`
}

InstanceGetStateResponse : State details of Analytics Engine instance.

type InstanceHome 

type InstanceHome struct {
	// UUID of the instance home storage instance.
	ID *string `json:"id,omitempty"`

	// Currently only ibm-cos (IBM Cloud Object Storage) is supported.
	Provider *string `json:"provider,omitempty"`

	// Type of the instance home storage. Currently, only objectstore (Cloud Object Storage) is supported.
	Type *string `json:"type,omitempty"`

	// Region of the Cloud Object Storage instance.
	Region *string `json:"region,omitempty"`

	// Endpoint to access the Cloud Object Storage instance.
	Endpoint *string `json:"endpoint,omitempty"`

	// Cloud Object Storage bucket used as instance home.
	Bucket *string `json:"bucket,omitempty"`

	// Cloud Object Storage access key. Masked for security reasons.
	HmacAccessKey *string `json:"hmac_access_key,omitempty"`

	// Cloud Object Storage secret key. Masked for security reasons.
	HmacSecretKey *string `json:"hmac_secret_key,omitempty"`
}

InstanceHome : Object storage instance that acts as the home for custom libraries and Spark events.

type InstanceHomeResponse 

type InstanceHomeResponse struct {
	// UUID of the instance home storage instance.
	InstanceID *string `json:"instance_id,omitempty"`

	// Currently only ibm-cos (IBM Cloud Object Storage) is supported.
	Provider *string `json:"provider,omitempty"`

	// Type of the instance home storage. Currently, only objectstore (Cloud Object Storage) is supported.
	Type *string `json:"type,omitempty"`

	// Region of the Cloud Object Storage instance.
	Region *string `json:"region,omitempty"`

	// Endpoint to access the Cloud Object Storage instance.
	Endpoint *string `json:"endpoint,omitempty"`

	// Cloud Object Storage access key.
	HmacAccessKey *string `json:"hmac_access_key,omitempty"`

	// Cloud Object Storage secret key.
	HmacSecretKey *string `json:"hmac_secret_key,omitempty"`
}

InstanceHomeResponse : Response of Instance home API.

type ListApplicationsOptions 

type ListApplicationsOptions struct {
	// The identifier of the Analytics Engine instance associated with the Spark application(s).
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// List of Spark application states that will be used to filter the response.
	State []string `json:"state,omitempty"`

	// Time interval to use for filtering applications by their start time. Interval is specified in the format `<lower
	// timestamp limit>,<upper timestamp limit>`. Each timestamp value must be ISO 8601 compliant. You may also use
	// keywords `BEGINNING` as a placeholder value for lower timestamp limit and `CURRENT` as a placeholder value for upper
	// timestamp limit. Note: The lower timestamp limit is inclusive, whereas the upper timestamp limit is exclusive.
	StartTimeInterval *string `json:"start_time_interval,omitempty"`

	// Time interval to use for filtering applications by their submission time. Interval is specified in the format
	// `<lower timestamp limit>,<upper timestamp limit>`. Each timestamp value must be ISO 8601 compliant. You may also use
	// keywords `BEGINNING` as a placeholder value for lower timestamp limit and `CURRENT` as a placeholder value for upper
	// timestamp limit. Note: The lower timestamp limit is inclusive, whereas the upper timestamp limit is exclusive.
	SubmissionTimeInterval *string `json:"submission_time_interval,omitempty"`

	// Time interval to use for filtering applications by their end time. Interval is specified in the format `<lower
	// timestamp limit>,<upper timestamp limit>`. Each timestamp value must be ISO 8601 compliant. You may also use
	// keywords `BEGINNING` as a placeholder value for lower timestamp limit and `CURRENT` as a placeholder value for upper
	// timestamp limit. Note: The lower timestamp limit is inclusive, whereas the upper timestamp limit is exclusive.
	EndTimeInterval *string `json:"end_time_interval,omitempty"`

	// Number of application entries to be included in the response.
	Limit *int64 `json:"limit,omitempty"`

	// Token used to fetch the next or the previous page of the applications list.
	Start *string `json:"start,omitempty"`

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

ListApplicationsOptions : The ListApplications options.

func (*ListApplicationsOptions) SetEndTimeInterval added in v2.3.0 

func (_options *ListApplicationsOptions) SetEndTimeInterval(endTimeInterval string) *ListApplicationsOptions

SetEndTimeInterval : Allow user to set EndTimeInterval

func (*ListApplicationsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ListApplicationsOptions) SetInstanceID 

func (_options *ListApplicationsOptions) SetInstanceID(instanceID string) *ListApplicationsOptions

SetInstanceID : Allow user to set InstanceID

func (*ListApplicationsOptions) SetLimit added in v2.2.0 

func (_options *ListApplicationsOptions) SetLimit(limit int64) *ListApplicationsOptions

SetLimit : Allow user to set Limit

func (*ListApplicationsOptions) SetStart added in v2.2.0 

func (_options *ListApplicationsOptions) SetStart(start string) *ListApplicationsOptions

SetStart : Allow user to set Start

func (*ListApplicationsOptions) SetStartTimeInterval added in v2.3.0 

func (_options *ListApplicationsOptions) SetStartTimeInterval(startTimeInterval string) *ListApplicationsOptions

SetStartTimeInterval : Allow user to set StartTimeInterval

func (*ListApplicationsOptions) SetState 

func (_options *ListApplicationsOptions) SetState(state []string) *ListApplicationsOptions

SetState : Allow user to set State

func (*ListApplicationsOptions) SetSubmissionTimeInterval added in v2.3.0 

func (_options *ListApplicationsOptions) SetSubmissionTimeInterval(submissionTimeInterval string) *ListApplicationsOptions

SetSubmissionTimeInterval : Allow user to set SubmissionTimeInterval

type LogForwardingConfigResponse 

type LogForwardingConfigResponse struct {
	// List of sources of logs that are being forwarded.
	Sources []string `json:"sources,omitempty"`

	// List of tags that are applied to the logs being forwarded.
	Tags []string `json:"tags,omitempty"`

	// Log server properties.
	LogServer *LogForwardingConfigResponseLogServer `json:"log_server,omitempty"`

	// Indicates whether log forwarding is enabled or not.
	Enabled *bool `json:"enabled,omitempty"`
}

LogForwardingConfigResponse : Log forwarding configuration details.

type LogForwardingConfigResponseLogServer 

type LogForwardingConfigResponseLogServer struct {
	// Type of the log server.
	Type *string `json:"type,omitempty"`
}

LogForwardingConfigResponseLogServer : Log server properties.

type LoggingConfigurationResponse 

type LoggingConfigurationResponse struct {
	// component array.
	Components []string `json:"components,omitempty"`

	// log server properties.
	LogServer *LoggingConfigurationResponseLogServer `json:"log_server,omitempty"`

	// enable.
	Enable *bool `json:"enable,omitempty"`
}

LoggingConfigurationResponse : (deprecated) Response of logging API.

type LoggingConfigurationResponseLogServer 

type LoggingConfigurationResponseLogServer struct {
	// type of log server.
	Type *string `json:"type,omitempty"`
}

LoggingConfigurationResponseLogServer : log server properties. 

type PageLink struct {
	// A url which returns a specific page of a collection.
	Href *string `json:"href" validate:"required"`

	// A token which loads a specific page of a collection when it is provided the url of the collection.
	Start *string `json:"start,omitempty"`
}

PageLink : A reference to a page in a paginated collection.

type ReplaceInstanceDefaultConfigsOptions 

type ReplaceInstanceDefaultConfigsOptions struct {
	// The ID of the Analytics Engine instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Spark configuration properties to replace existing instance default Spark configurations.
	Body map[string]string `json:"body" validate:"required"`

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

ReplaceInstanceDefaultConfigsOptions : The ReplaceInstanceDefaultConfigs options.

func (*ReplaceInstanceDefaultConfigsOptions) SetBody 

func (_options *ReplaceInstanceDefaultConfigsOptions) SetBody(body map[string]string) *ReplaceInstanceDefaultConfigsOptions

SetBody : Allow user to set Body

func (*ReplaceInstanceDefaultConfigsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ReplaceInstanceDefaultConfigsOptions) SetInstanceID 

func (_options *ReplaceInstanceDefaultConfigsOptions) SetInstanceID(instanceID string) *ReplaceInstanceDefaultConfigsOptions

SetInstanceID : Allow user to set InstanceID

type ReplaceInstanceDefaultRuntimeOptions 

type ReplaceInstanceDefaultRuntimeOptions struct {
	// The ID of the Analytics Engine instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Spark version of the runtime environment.
	SparkVersion *string `json:"spark_version,omitempty"`

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

ReplaceInstanceDefaultRuntimeOptions : The ReplaceInstanceDefaultRuntime options.

func (*ReplaceInstanceDefaultRuntimeOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ReplaceInstanceDefaultRuntimeOptions) SetInstanceID 

func (_options *ReplaceInstanceDefaultRuntimeOptions) SetInstanceID(instanceID string) *ReplaceInstanceDefaultRuntimeOptions

SetInstanceID : Allow user to set InstanceID

func (*ReplaceInstanceDefaultRuntimeOptions) SetSparkVersion 

func (_options *ReplaceInstanceDefaultRuntimeOptions) SetSparkVersion(sparkVersion string) *ReplaceInstanceDefaultRuntimeOptions

SetSparkVersion : Allow user to set SparkVersion

type ReplaceLogForwardingConfigOptions 

type ReplaceLogForwardingConfigOptions struct {
	// ID of the Analytics Engine instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Enable or disable log forwarding.
	Enabled *bool `json:"enabled,omitempty"`

	// List of sources of logs that will be forwarded. By default, only 'spark-driver' logs are forwarded.
	Sources []string `json:"sources,omitempty"`

	// List of tags to be applied to the logs being forwarded. They can be used to filter the logs in the IBM Log Analysis
	// server.
	Tags []string `json:"tags,omitempty"`

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

ReplaceLogForwardingConfigOptions : The ReplaceLogForwardingConfig options.

func (*ReplaceLogForwardingConfigOptions) SetEnabled 

func (_options *ReplaceLogForwardingConfigOptions) SetEnabled(enabled bool) *ReplaceLogForwardingConfigOptions

SetEnabled : Allow user to set Enabled

func (*ReplaceLogForwardingConfigOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ReplaceLogForwardingConfigOptions) SetInstanceID 

func (_options *ReplaceLogForwardingConfigOptions) SetInstanceID(instanceID string) *ReplaceLogForwardingConfigOptions

SetInstanceID : Allow user to set InstanceID

func (*ReplaceLogForwardingConfigOptions) SetSources 

func (_options *ReplaceLogForwardingConfigOptions) SetSources(sources []string) *ReplaceLogForwardingConfigOptions

SetSources : Allow user to set Sources

func (*ReplaceLogForwardingConfigOptions) SetTags 

func (_options *ReplaceLogForwardingConfigOptions) SetTags(tags []string) *ReplaceLogForwardingConfigOptions

SetTags : Allow user to set Tags

type ResourceConsumptionLimitsResponse 

type ResourceConsumptionLimitsResponse struct {
	// Maximum number of virtual processor cores that be used in the instance.
	MaxCores *string `json:"max_cores,omitempty"`

	// Maximum memory that can be used in the instance.
	MaxMemory *string `json:"max_memory,omitempty"`
}

ResourceConsumptionLimitsResponse : Resource consumption limits for the instance.

type Runtime 

type Runtime struct {
	// Spark version of the runtime environment.
	SparkVersion *string `json:"spark_version,omitempty"`
}

Runtime : Runtime enviroment for applications and other workloads.

type SetInstanceHomeOptions 

type SetInstanceHomeOptions struct {
	// The ID of the Analytics Engine instance.
	InstanceID *string `json:"-" validate:"required,ne="`

	// UUID of the instance home storage instance.
	NewInstanceID *string `json:"instance_id,omitempty"`

	// Currently only ibm-cos (IBM Cloud Object Storage) is supported.
	NewProvider *string `json:"provider,omitempty"`

	// Type of the instance home storage. Currently, only objectstore (Cloud Object Storage) is supported.
	NewType *string `json:"type,omitempty"`

	// Region of the Cloud Object Storage instance.
	NewRegion *string `json:"region,omitempty"`

	// Endpoint to access the Cloud Object Storage instance.
	NewEndpoint *string `json:"endpoint,omitempty"`

	// Cloud Object Storage access key.
	NewHmacAccessKey *string `json:"hmac_access_key,omitempty"`

	// Cloud Object Storage secret key.
	NewHmacSecretKey *string `json:"hmac_secret_key,omitempty"`

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

SetInstanceHomeOptions : The SetInstanceHome options.

func (*SetInstanceHomeOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*SetInstanceHomeOptions) SetInstanceID 

func (_options *SetInstanceHomeOptions) SetInstanceID(instanceID string) *SetInstanceHomeOptions

SetInstanceID : Allow user to set InstanceID

func (*SetInstanceHomeOptions) SetNewEndpoint 

func (_options *SetInstanceHomeOptions) SetNewEndpoint(newEndpoint string) *SetInstanceHomeOptions

SetNewEndpoint : Allow user to set NewEndpoint

func (*SetInstanceHomeOptions) SetNewHmacAccessKey 

func (_options *SetInstanceHomeOptions) SetNewHmacAccessKey(newHmacAccessKey string) *SetInstanceHomeOptions

SetNewHmacAccessKey : Allow user to set NewHmacAccessKey

func (*SetInstanceHomeOptions) SetNewHmacSecretKey 

func (_options *SetInstanceHomeOptions) SetNewHmacSecretKey(newHmacSecretKey string) *SetInstanceHomeOptions

SetNewHmacSecretKey : Allow user to set NewHmacSecretKey

func (*SetInstanceHomeOptions) SetNewInstanceID 

func (_options *SetInstanceHomeOptions) SetNewInstanceID(newInstanceID string) *SetInstanceHomeOptions

SetNewInstanceID : Allow user to set NewInstanceID

func (*SetInstanceHomeOptions) SetNewProvider 

func (_options *SetInstanceHomeOptions) SetNewProvider(newProvider string) *SetInstanceHomeOptions

SetNewProvider : Allow user to set NewProvider

func (*SetInstanceHomeOptions) SetNewRegion 

func (_options *SetInstanceHomeOptions) SetNewRegion(newRegion string) *SetInstanceHomeOptions

SetNewRegion : Allow user to set NewRegion

func (*SetInstanceHomeOptions) SetNewType 

func (_options *SetInstanceHomeOptions) SetNewType(newType string) *SetInstanceHomeOptions

SetNewType : Allow user to set NewType

type SparkHistoryServerResponse 

type SparkHistoryServerResponse struct {
	// State of the Spark history server.
	State *string `json:"state,omitempty"`

	// Number of cpu cores used by the Spark history server.
	Cores *string `json:"cores,omitempty"`

	// Amount of memory used by the Spark history server.
	Memory *string `json:"memory,omitempty"`

	// Time when the Spark history server was started.
	StartTime *strfmt.DateTime `json:"start_time,omitempty"`

	// Time when the Spark history server was stopped.
	StopTime *strfmt.DateTime `json:"stop_time,omitempty"`

	// Time when the Spark history server will be stopped automatically.
	AutoTerminationTime *strfmt.DateTime `json:"auto_termination_time,omitempty"`
}

SparkHistoryServerResponse : Status of the Spark history server.

type StartSparkHistoryServerOptions 

type StartSparkHistoryServerOptions struct {
	// The ID of the Analytics Engine instance to which the Spark history server belongs.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

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

StartSparkHistoryServerOptions : The StartSparkHistoryServer options.

func (*StartSparkHistoryServerOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*StartSparkHistoryServerOptions) SetInstanceID 

func (_options *StartSparkHistoryServerOptions) SetInstanceID(instanceID string) *StartSparkHistoryServerOptions

SetInstanceID : Allow user to set InstanceID

type StopSparkHistoryServerOptions 

type StopSparkHistoryServerOptions struct {
	// The ID of the Analytics Engine instance to which the Spark history server belongs.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

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

StopSparkHistoryServerOptions : The StopSparkHistoryServer options.

func (*StopSparkHistoryServerOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*StopSparkHistoryServerOptions) SetInstanceID 

func (_options *StopSparkHistoryServerOptions) SetInstanceID(instanceID string) *StopSparkHistoryServerOptions

SetInstanceID : Allow user to set InstanceID

type UpdateInstanceDefaultConfigsOptions 

type UpdateInstanceDefaultConfigsOptions struct {
	// The ID of the Analytics Engine instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Spark configuration properties to be updated. Properties will be merged with existing configuration properties. Set
	// a property value to `null` in order to unset it.
	Body map[string]interface{} `json:"body" validate:"required"`

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

UpdateInstanceDefaultConfigsOptions : The UpdateInstanceDefaultConfigs options.

func (*UpdateInstanceDefaultConfigsOptions) SetBody 

func (_options *UpdateInstanceDefaultConfigsOptions) SetBody(body map[string]interface{}) *UpdateInstanceDefaultConfigsOptions

SetBody : Allow user to set Body

func (*UpdateInstanceDefaultConfigsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*UpdateInstanceDefaultConfigsOptions) SetInstanceID 

func (_options *UpdateInstanceDefaultConfigsOptions) SetInstanceID(instanceID string) *UpdateInstanceDefaultConfigsOptions

SetInstanceID : Allow user to set InstanceID

type UpdateInstanceHomeCredentialsOptions added in v2.1.0 

type UpdateInstanceHomeCredentialsOptions struct {
	// The ID of the Analytics Engine instance.
	InstanceID *string `json:"instance_id" validate:"required,ne="`

	// Cloud Object Storage access key.
	HmacAccessKey *string `json:"hmac_access_key" validate:"required"`

	// Cloud Object Storage secret key.
	HmacSecretKey *string `json:"hmac_secret_key" validate:"required"`

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

UpdateInstanceHomeCredentialsOptions : The UpdateInstanceHomeCredentials options.

func (*UpdateInstanceHomeCredentialsOptions) SetHeaders added in v2.1.0 

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

SetHeaders : Allow user to set Headers

func (*UpdateInstanceHomeCredentialsOptions) SetHmacAccessKey added in v2.1.0 

func (_options *UpdateInstanceHomeCredentialsOptions) SetHmacAccessKey(hmacAccessKey string) *UpdateInstanceHomeCredentialsOptions

SetHmacAccessKey : Allow user to set HmacAccessKey

func (*UpdateInstanceHomeCredentialsOptions) SetHmacSecretKey added in v2.1.0 

func (_options *UpdateInstanceHomeCredentialsOptions) SetHmacSecretKey(hmacSecretKey string) *UpdateInstanceHomeCredentialsOptions

SetHmacSecretKey : Allow user to set HmacSecretKey

func (*UpdateInstanceHomeCredentialsOptions) SetInstanceID added in v2.1.0 

func (_options *UpdateInstanceHomeCredentialsOptions) SetInstanceID(instanceID string) *UpdateInstanceHomeCredentialsOptions

SetInstanceID : Allow user to set InstanceID

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.