ibmanalyticsengineapiv3

package
v1.1.0 Latest Latest
Warning

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

 Go to latest Published: Nov 24, 2022 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_Error          = "error"
	Application_State_Failed         = "failed"
	Application_State_Finished       = "finished"
	Application_State_OpsTerminated  = "ops_terminated"
	Application_State_Running        = "running"
	Application_State_Stopped        = "stopped"
	Application_State_Submitted      = "submitted"
	Application_State_Unknown        = "unknown"
	Application_State_Waiting        = "waiting"
)

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_Error          = "error"
	ApplicationGetResponse_State_Failed         = "failed"
	ApplicationGetResponse_State_Finished       = "finished"
	ApplicationGetResponse_State_OpsTerminated  = "ops_terminated"
	ApplicationGetResponse_State_Running        = "running"
	ApplicationGetResponse_State_Stopped        = "stopped"
	ApplicationGetResponse_State_Submitted      = "submitted"
	ApplicationGetResponse_State_Unknown        = "unknown"
	ApplicationGetResponse_State_Waiting        = "waiting"
)

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_Error          = "error"
	ApplicationGetStateResponse_State_Failed         = "failed"
	ApplicationGetStateResponse_State_Finished       = "finished"
	ApplicationGetStateResponse_State_OpsTerminated  = "ops_terminated"
	ApplicationGetStateResponse_State_Running        = "running"
	ApplicationGetStateResponse_State_Stopped        = "stopped"
	ApplicationGetStateResponse_State_Submitted      = "submitted"
	ApplicationGetStateResponse_State_Unknown        = "unknown"
	ApplicationGetStateResponse_State_Waiting        = "waiting"
)

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_Error          = "error"
	ApplicationResponse_State_Failed         = "failed"
	ApplicationResponse_State_Finished       = "finished"
	ApplicationResponse_State_OpsTerminated  = "ops_terminated"
	ApplicationResponse_State_Running        = "running"
	ApplicationResponse_State_Stopped        = "stopped"
	ApplicationResponse_State_Submitted      = "submitted"
	ApplicationResponse_State_Unknown        = "unknown"
	ApplicationResponse_State_Waiting        = "waiting"
)

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_Error          = "error"
	ListApplicationsOptions_State_Failed         = "failed"
	ListApplicationsOptions_State_Finished       = "finished"
	ListApplicationsOptions_State_OpsTerminated  = "ops_terminated"
	ListApplicationsOptions_State_Running        = "running"
	ListApplicationsOptions_State_Stopped        = "stopped"
	ListApplicationsOptions_State_Submitted      = "submitted"
	ListApplicationsOptions_State_Unknown        = "unknown"
	ListApplicationsOptions_State_Waiting        = "waiting"
)

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

View Source 
const DefaultServiceName = "ibm_analytics_engine_api"

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 added in v0.4.1 

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 added in v1.1.0 

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 added in v1.0.0 

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 added in v0.4.1 

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 added in v0.4.1 

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 added in v0.4.5 

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 added in v0.4.1 

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 added in v0.4.5 

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 added in v1.0.0 

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 added in v1.0.0 

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 added in v0.4.5 

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 added in v0.4.5 

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 UnmarshalResourceConsumptionLimitsResponse added in v1.1.0 

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 added in v1.1.0 

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

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

Types

type Application added in v0.4.1 

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"`

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

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

	// Time when the application was completed.
	FinishTime *string `json:"finish_time,omitempty"`
}

Application : Details of a Spark application.

type ApplicationCollection 

type ApplicationCollection struct {
	// List of applications.
	Applications []Application `json:"applications,omitempty"`
}

ApplicationCollection : An array of application details.

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"`

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

	// Application start time in the format YYYY-MM-DDTHH:mm:ssZ.
	StartTime *strfmt.DateTime `json:"start_time,omitempty"`

	// Application end time in the format YYYY-MM-DDTHH:mm:ssZ.
	EndTime *strfmt.DateTime `json:"end_time,omitempty"`

	// Application finish time in the format YYYY-MM-DDTHH:mm:ssZ.
	FinishTime *strfmt.DateTime `json:"finish_time,omitempty"`
}

ApplicationGetResponse : Response of the Application Get API.

type ApplicationGetResponseStateDetailsItem added in v1.1.0 

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 *string `json:"start_time,omitempty"`

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

	// Time when the application was completed.
	FinishTime *string `json:"finish_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 ConfigurePlatformLoggingOptions added in v0.5.0 

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

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

SetEnable : Allow user to set Enable

func (*ConfigurePlatformLoggingOptions) SetHeaders added in v0.5.0 

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

SetHeaders : Allow user to set Headers

func (*ConfigurePlatformLoggingOptions) SetInstanceGuid added in v0.5.0 

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 added in v0.3.0 

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

SetApplication : Allow user to set Application

func (*CreateApplicationOptions) SetArchives added in v0.5.0 

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

SetArchives : Allow user to set Archives

func (*CreateApplicationOptions) SetArguments added in v0.4.1 

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

SetArguments : Allow user to set Arguments

func (*CreateApplicationOptions) SetClass added in v0.3.1 

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

SetClass : Allow user to set Class

func (*CreateApplicationOptions) SetConf added in v0.3.0 

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

SetConf : Allow user to set Conf

func (*CreateApplicationOptions) SetEnv added in v0.3.0 

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

SetEnv : Allow user to set Env

func (*CreateApplicationOptions) SetFiles added in v0.5.0 

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

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

SetJars : Allow user to set Jars

func (*CreateApplicationOptions) SetName added in v0.5.0 

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

SetName : Allow user to set Name

func (*CreateApplicationOptions) SetPackages added in v0.5.0 

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

SetPackages : Allow user to set Packages

func (*CreateApplicationOptions) SetRepositories added in v0.5.0 

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

SetRepositories : Allow user to set Repositories

func (*CreateApplicationOptions) SetRuntime added in v1.1.0 

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

SetRuntime : Allow user to set Runtime

type CurrentResourceConsumptionResponse added in v1.0.0 

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 added in v0.4.2 

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 added in v0.4.2 

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

SetApplicationID : Allow user to set ApplicationID

func (*DeleteApplicationOptions) SetHeaders added in v0.4.2 

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

SetHeaders : Allow user to set Headers

func (*DeleteApplicationOptions) SetInstanceID added in v0.4.2 

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

SetInstanceID : Allow user to set InstanceID

type GetApplicationOptions added in v0.4.1 

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 added in v0.4.1 

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

SetApplicationID : Allow user to set ApplicationID

func (*GetApplicationOptions) SetHeaders added in v0.4.1 

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

SetHeaders : Allow user to set Headers

func (*GetApplicationOptions) SetInstanceID added in v0.4.1 

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 added in v1.0.0 

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 added in v1.0.0 

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

SetHeaders : Allow user to set Headers

func (*GetCurrentResourceConsumptionOptions) SetInstanceID added in v1.0.0 

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

SetInstanceID : Allow user to set InstanceID

type GetInstanceDefaultConfigsOptions added in v1.0.0 

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 added in v1.0.0 

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

SetHeaders : Allow user to set Headers

func (*GetInstanceDefaultConfigsOptions) SetInstanceID added in v1.0.0 

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

SetInstanceID : Allow user to set InstanceID

type GetInstanceDefaultRuntimeOptions added in v1.1.0 

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 added in v1.1.0 

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

SetHeaders : Allow user to set Headers

func (*GetInstanceDefaultRuntimeOptions) SetInstanceID added in v1.1.0 

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

SetInstanceID : Allow user to set InstanceID

type GetInstanceOptions added in v0.4.1 

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 added in v0.4.1 

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

SetHeaders : Allow user to set Headers

func (*GetInstanceOptions) SetInstanceID added in v0.4.1 

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

SetInstanceID : Allow user to set InstanceID

type GetInstanceStateOptions added in v0.4.5 

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 added in v0.4.5 

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

SetHeaders : Allow user to set Headers

func (*GetInstanceStateOptions) SetInstanceID added in v0.4.5 

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

SetInstanceID : Allow user to set InstanceID

type GetLogForwardingConfigOptions added in v1.0.0 

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 added in v1.0.0 

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

SetHeaders : Allow user to set Headers

func (*GetLogForwardingConfigOptions) SetInstanceID added in v1.0.0 

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

SetInstanceID : Allow user to set InstanceID

type GetLoggingConfigurationOptions added in v0.4.5 

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 added in v0.4.5 

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

SetHeaders : Allow user to set Headers

func (*GetLoggingConfigurationOptions) SetInstanceGuid added in v0.4.5 

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

SetInstanceGuid : Allow user to set InstanceGuid

type GetResourceConsumptionLimitsOptions added in v1.1.0 

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 added in v1.1.0 

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

SetHeaders : Allow user to set Headers

func (*GetResourceConsumptionLimitsOptions) SetInstanceID added in v1.1.0 

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

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

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.

func (*IbmAnalyticsEngineApiV3) ConfigurePlatformLoggingWithContext added in v0.5.0 

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

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 added in v0.4.2 

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 added in v0.4.2 

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 added in v0.4.1 

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 added in v0.4.1 

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 added in v1.0.0 

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 added in v1.0.0 

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 added in v0.4.1 

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 added in v1.0.0 

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 added in v1.0.0 

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 added in v1.1.0 

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 added in v1.1.0 

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 added in v0.4.5 

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 added in v0.4.5 

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 added in v0.4.1 

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 added in v1.0.0 

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 added in v1.0.0 

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 added in v0.4.5 

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.

func (*IbmAnalyticsEngineApiV3) GetLoggingConfigurationWithContext added in v0.4.5 

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

func (*IbmAnalyticsEngineApiV3) GetResourceConsumptionLimits added in v1.1.0 

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 added in v1.1.0 

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) ListApplications added in v0.4.1 

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 added in v0.4.1 

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) NewConfigurePlatformLoggingOptions added in v0.5.0 

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

NewConfigurePlatformLoggingOptions : Instantiate ConfigurePlatformLoggingOptions

func (*IbmAnalyticsEngineApiV3) NewCreateApplicationOptions 

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

NewCreateApplicationOptions : Instantiate CreateApplicationOptions

func (*IbmAnalyticsEngineApiV3) NewDeleteApplicationOptions added in v0.4.2 

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

NewDeleteApplicationOptions : Instantiate DeleteApplicationOptions

func (*IbmAnalyticsEngineApiV3) NewGetApplicationOptions added in v0.4.1 

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 added in v1.0.0 

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

NewGetCurrentResourceConsumptionOptions : Instantiate GetCurrentResourceConsumptionOptions

func (*IbmAnalyticsEngineApiV3) NewGetInstanceDefaultConfigsOptions added in v1.0.0 

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

NewGetInstanceDefaultConfigsOptions : Instantiate GetInstanceDefaultConfigsOptions

func (*IbmAnalyticsEngineApiV3) NewGetInstanceDefaultRuntimeOptions added in v1.1.0 

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

NewGetInstanceDefaultRuntimeOptions : Instantiate GetInstanceDefaultRuntimeOptions

func (*IbmAnalyticsEngineApiV3) NewGetInstanceOptions added in v0.4.1 

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

NewGetInstanceOptions : Instantiate GetInstanceOptions

func (*IbmAnalyticsEngineApiV3) NewGetInstanceStateOptions added in v0.4.5 

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

NewGetInstanceStateOptions : Instantiate GetInstanceStateOptions

func (*IbmAnalyticsEngineApiV3) NewGetLogForwardingConfigOptions added in v1.0.0 

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

NewGetLogForwardingConfigOptions : Instantiate GetLogForwardingConfigOptions

func (*IbmAnalyticsEngineApiV3) NewGetLoggingConfigurationOptions added in v0.4.5 

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

NewGetLoggingConfigurationOptions : Instantiate GetLoggingConfigurationOptions

func (*IbmAnalyticsEngineApiV3) NewGetResourceConsumptionLimitsOptions added in v1.1.0 

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

NewGetResourceConsumptionLimitsOptions : Instantiate GetResourceConsumptionLimitsOptions

func (*IbmAnalyticsEngineApiV3) NewListApplicationsOptions added in v0.4.1 

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

NewListApplicationsOptions : Instantiate ListApplicationsOptions

func (*IbmAnalyticsEngineApiV3) NewReplaceInstanceDefaultConfigsOptions added in v1.0.0 

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

NewReplaceInstanceDefaultConfigsOptions : Instantiate ReplaceInstanceDefaultConfigsOptions

func (*IbmAnalyticsEngineApiV3) NewReplaceInstanceDefaultRuntimeOptions added in v1.1.0 

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

NewReplaceInstanceDefaultRuntimeOptions : Instantiate ReplaceInstanceDefaultRuntimeOptions

func (*IbmAnalyticsEngineApiV3) NewReplaceLogForwardingConfigOptions added in v1.0.0 

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

NewReplaceLogForwardingConfigOptions : Instantiate ReplaceLogForwardingConfigOptions

func (*IbmAnalyticsEngineApiV3) NewSetInstanceHomeOptions added in v1.0.0 

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

NewSetInstanceHomeOptions : Instantiate SetInstanceHomeOptions

func (*IbmAnalyticsEngineApiV3) NewUpdateInstanceDefaultConfigsOptions added in v1.0.0 

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

NewUpdateInstanceDefaultConfigsOptions : Instantiate UpdateInstanceDefaultConfigsOptions

func (*IbmAnalyticsEngineApiV3) ReplaceInstanceDefaultConfigs added in v1.0.0 

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 added in v1.0.0 

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 added in v1.1.0 

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 added in v1.1.0 

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 added in v1.0.0 

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 added in v1.0.0 

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 added in v1.0.0 

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 added in v1.0.0 

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) UpdateInstanceDefaultConfigs added in v1.0.0 

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 added in v1.0.0 

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

type IbmAnalyticsEngineApiV3Options 

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

IbmAnalyticsEngineApiV3Options : Service options

type Instance added in v0.4.1 

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 added in v0.4.1 

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

InstanceDefaultConfig : Instance level default configuration for Spark workloads.

type InstanceGetStateResponse added in v0.4.5 

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 added in v0.4.1 

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 added in v0.4.5 

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 added in v0.4.1 

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"`

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

ListApplicationsOptions : The ListApplications options.

func (*ListApplicationsOptions) SetHeaders added in v0.4.1 

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

SetHeaders : Allow user to set Headers

func (*ListApplicationsOptions) SetInstanceID added in v0.4.1 

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

SetInstanceID : Allow user to set InstanceID

func (*ListApplicationsOptions) SetState added in v1.1.0 

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

SetState : Allow user to set State

type LogForwardingConfigResponse added in v1.0.0 

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 added in v1.0.0 

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

LogForwardingConfigResponseLogServer : Log server properties.

type LoggingConfigurationResponse added in v0.4.5 

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 : Response of logging API.

type LoggingConfigurationResponseLogServer added in v0.4.5 

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

LoggingConfigurationResponseLogServer : log server properties.

type ReplaceInstanceDefaultConfigsOptions added in v1.0.0 

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 added in v1.0.0 

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

SetBody : Allow user to set Body

func (*ReplaceInstanceDefaultConfigsOptions) SetHeaders added in v1.0.0 

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

SetHeaders : Allow user to set Headers

func (*ReplaceInstanceDefaultConfigsOptions) SetInstanceID added in v1.0.0 

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

SetInstanceID : Allow user to set InstanceID

type ReplaceInstanceDefaultRuntimeOptions added in v1.1.0 

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 added in v1.1.0 

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

SetHeaders : Allow user to set Headers

func (*ReplaceInstanceDefaultRuntimeOptions) SetInstanceID added in v1.1.0 

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

SetInstanceID : Allow user to set InstanceID

func (*ReplaceInstanceDefaultRuntimeOptions) SetSparkVersion added in v1.1.0 

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

SetSparkVersion : Allow user to set SparkVersion

type ReplaceLogForwardingConfigOptions added in v1.0.0 

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 added in v1.0.0 

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

SetEnabled : Allow user to set Enabled

func (*ReplaceLogForwardingConfigOptions) SetHeaders added in v1.0.0 

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

SetHeaders : Allow user to set Headers

func (*ReplaceLogForwardingConfigOptions) SetInstanceID added in v1.0.0 

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

SetInstanceID : Allow user to set InstanceID

func (*ReplaceLogForwardingConfigOptions) SetSources added in v1.0.0 

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

SetSources : Allow user to set Sources

func (*ReplaceLogForwardingConfigOptions) SetTags added in v1.0.0 

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

SetTags : Allow user to set Tags

type ResourceConsumptionLimitsResponse added in v1.1.0 

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 added in v1.1.0 

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 added in v1.0.0 

type SetInstanceHomeOptions struct {
	// The ID of the Analytics Engine instance for which 'instance home' is to be set.
	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 added in v1.0.0 

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

SetHeaders : Allow user to set Headers

func (*SetInstanceHomeOptions) SetInstanceID added in v1.0.0 

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

SetInstanceID : Allow user to set InstanceID

func (*SetInstanceHomeOptions) SetNewEndpoint added in v1.0.0 

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

SetNewEndpoint : Allow user to set NewEndpoint

func (*SetInstanceHomeOptions) SetNewHmacAccessKey added in v1.0.0 

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

SetNewHmacAccessKey : Allow user to set NewHmacAccessKey

func (*SetInstanceHomeOptions) SetNewHmacSecretKey added in v1.0.0 

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

SetNewHmacSecretKey : Allow user to set NewHmacSecretKey

func (*SetInstanceHomeOptions) SetNewInstanceID added in v1.0.0 

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

SetNewInstanceID : Allow user to set NewInstanceID

func (*SetInstanceHomeOptions) SetNewProvider added in v1.0.0 

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

SetNewProvider : Allow user to set NewProvider

func (*SetInstanceHomeOptions) SetNewRegion added in v1.0.0 

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

SetNewRegion : Allow user to set NewRegion

func (*SetInstanceHomeOptions) SetNewType added in v1.0.0 

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

SetNewType : Allow user to set NewType

type UpdateInstanceDefaultConfigsOptions added in v1.0.0 

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 added in v1.0.0 

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

SetBody : Allow user to set Body

func (*UpdateInstanceDefaultConfigsOptions) SetHeaders added in v1.0.0 

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

SetHeaders : Allow user to set Headers

func (*UpdateInstanceDefaultConfigsOptions) SetInstanceID added in v1.0.0 

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

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.