analytics

package
v65.69.3 Latest Latest
Warning

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

 Go to latest Published: Jul 23, 2024 License: Apache-2.0, UPL-1.0 Imports: 7 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetAccessControlServiceTypeEnumStringValues added in v65.18.1 

func GetAccessControlServiceTypeEnumStringValues() []string

GetAccessControlServiceTypeEnumStringValues Enumerates the set of values in String for AccessControlServiceTypeEnum

func GetAnalyticsInstanceLifecycleStateEnumStringValues 

func GetAnalyticsInstanceLifecycleStateEnumStringValues() []string

GetAnalyticsInstanceLifecycleStateEnumStringValues Enumerates the set of values in String for AnalyticsInstanceLifecycleStateEnum

func GetCapacityTypeEnumStringValues 

func GetCapacityTypeEnumStringValues() []string

GetCapacityTypeEnumStringValues Enumerates the set of values in String for CapacityTypeEnum

func GetFeatureSetEnumStringValues 

func GetFeatureSetEnumStringValues() []string

GetFeatureSetEnumStringValues Enumerates the set of values in String for FeatureSetEnum

func GetLicenseTypeEnumStringValues 

func GetLicenseTypeEnumStringValues() []string

GetLicenseTypeEnumStringValues Enumerates the set of values in String for LicenseTypeEnum

func GetListAnalyticsInstancesCapacityTypeEnumStringValues 

func GetListAnalyticsInstancesCapacityTypeEnumStringValues() []string

GetListAnalyticsInstancesCapacityTypeEnumStringValues Enumerates the set of values in String for ListAnalyticsInstancesCapacityTypeEnum

func GetListAnalyticsInstancesFeatureSetEnumStringValues 

func GetListAnalyticsInstancesFeatureSetEnumStringValues() []string

GetListAnalyticsInstancesFeatureSetEnumStringValues Enumerates the set of values in String for ListAnalyticsInstancesFeatureSetEnum

func GetListAnalyticsInstancesLifecycleStateEnumStringValues 

func GetListAnalyticsInstancesLifecycleStateEnumStringValues() []string

GetListAnalyticsInstancesLifecycleStateEnumStringValues Enumerates the set of values in String for ListAnalyticsInstancesLifecycleStateEnum

func GetListAnalyticsInstancesSortByEnumStringValues 

func GetListAnalyticsInstancesSortByEnumStringValues() []string

GetListAnalyticsInstancesSortByEnumStringValues Enumerates the set of values in String for ListAnalyticsInstancesSortByEnum

func GetListAnalyticsInstancesSortOrderEnumStringValues 

func GetListAnalyticsInstancesSortOrderEnumStringValues() []string

GetListAnalyticsInstancesSortOrderEnumStringValues Enumerates the set of values in String for ListAnalyticsInstancesSortOrderEnum

func GetListWorkRequestsResourceTypeEnumStringValues 

func GetListWorkRequestsResourceTypeEnumStringValues() []string

GetListWorkRequestsResourceTypeEnumStringValues Enumerates the set of values in String for ListWorkRequestsResourceTypeEnum

func GetListWorkRequestsSortByEnumStringValues 

func GetListWorkRequestsSortByEnumStringValues() []string

GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortOrderEnumStringValues 

func GetListWorkRequestsSortOrderEnumStringValues() []string

GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum

func GetNetworkEndpointTypeEnumStringValues 

func GetNetworkEndpointTypeEnumStringValues() []string

GetNetworkEndpointTypeEnumStringValues Enumerates the set of values in String for NetworkEndpointTypeEnum

func GetSortByEnumStringValues 

func GetSortByEnumStringValues() []string

GetSortByEnumStringValues Enumerates the set of values in String for SortByEnum

func GetSortOrderEnumStringValues 

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

func GetWorkRequestActionResultEnumStringValues 

func GetWorkRequestActionResultEnumStringValues() []string

GetWorkRequestActionResultEnumStringValues Enumerates the set of values in String for WorkRequestActionResultEnum

func GetWorkRequestOperationTypeEnumStringValues 

func GetWorkRequestOperationTypeEnumStringValues() []string

GetWorkRequestOperationTypeEnumStringValues Enumerates the set of values in String for WorkRequestOperationTypeEnum

func GetWorkRequestResourceTypeEnumStringValues 

func GetWorkRequestResourceTypeEnumStringValues() []string

GetWorkRequestResourceTypeEnumStringValues Enumerates the set of values in String for WorkRequestResourceTypeEnum

func GetWorkRequestSortByEnumStringValues 

func GetWorkRequestSortByEnumStringValues() []string

GetWorkRequestSortByEnumStringValues Enumerates the set of values in String for WorkRequestSortByEnum

func GetWorkRequestStatusEnumStringValues 

func GetWorkRequestStatusEnumStringValues() []string

GetWorkRequestStatusEnumStringValues Enumerates the set of values in String for WorkRequestStatusEnum

Types

type AccessControlServiceTypeEnum added in v65.18.1 

type AccessControlServiceTypeEnum string

AccessControlServiceTypeEnum Enum with underlying type: string 

const (
	AccessControlServiceTypeAll AccessControlServiceTypeEnum = "ALL"
)

Set of constants representing the allowable values for AccessControlServiceTypeEnum

func GetAccessControlServiceTypeEnumValues added in v65.18.1 

func GetAccessControlServiceTypeEnumValues() []AccessControlServiceTypeEnum

GetAccessControlServiceTypeEnumValues Enumerates the set of values for AccessControlServiceTypeEnum

func GetMappingAccessControlServiceTypeEnum added in v65.18.1 

func GetMappingAccessControlServiceTypeEnum(val string) (AccessControlServiceTypeEnum, bool)

GetMappingAccessControlServiceTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type AnalyticsClient 

type AnalyticsClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

AnalyticsClient a client for Analytics

func NewAnalyticsClientWithConfigurationProvider 

func NewAnalyticsClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client AnalyticsClient, err error)

NewAnalyticsClientWithConfigurationProvider Creates a new default Analytics client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewAnalyticsClientWithOboToken 

func NewAnalyticsClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client AnalyticsClient, err error)

NewAnalyticsClientWithOboToken Creates a new default Analytics client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer 

as well as reading the region

func (AnalyticsClient) ChangeAnalyticsInstanceCompartment 

func (client AnalyticsClient) ChangeAnalyticsInstanceCompartment(ctx context.Context, request ChangeAnalyticsInstanceCompartmentRequest) (response ChangeAnalyticsInstanceCompartmentResponse, err error)

ChangeAnalyticsInstanceCompartment Change the compartment of an Analytics instance. The operation is long-running and creates a new WorkRequest.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/ChangeAnalyticsInstanceCompartment.go.html to see an example of how to use ChangeAnalyticsInstanceCompartment API. A default retry strategy applies to this operation ChangeAnalyticsInstanceCompartment()

func (AnalyticsClient) ChangeAnalyticsInstanceNetworkEndpoint 

func (client AnalyticsClient) ChangeAnalyticsInstanceNetworkEndpoint(ctx context.Context, request ChangeAnalyticsInstanceNetworkEndpointRequest) (response ChangeAnalyticsInstanceNetworkEndpointResponse, err error)

ChangeAnalyticsInstanceNetworkEndpoint Change an Analytics instance network endpoint. The operation is long-running and creates a new WorkRequest.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/ChangeAnalyticsInstanceNetworkEndpoint.go.html to see an example of how to use ChangeAnalyticsInstanceNetworkEndpoint API. A default retry strategy applies to this operation ChangeAnalyticsInstanceNetworkEndpoint()

func (*AnalyticsClient) ConfigurationProvider 

func (client *AnalyticsClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (AnalyticsClient) CreateAnalyticsInstance 

func (client AnalyticsClient) CreateAnalyticsInstance(ctx context.Context, request CreateAnalyticsInstanceRequest) (response CreateAnalyticsInstanceResponse, err error)

CreateAnalyticsInstance Create a new AnalyticsInstance in the specified compartment. The operation is long-running and creates a new WorkRequest.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/CreateAnalyticsInstance.go.html to see an example of how to use CreateAnalyticsInstance API. A default retry strategy applies to this operation CreateAnalyticsInstance()

func (AnalyticsClient) CreatePrivateAccessChannel 

func (client AnalyticsClient) CreatePrivateAccessChannel(ctx context.Context, request CreatePrivateAccessChannelRequest) (response CreatePrivateAccessChannelResponse, err error)

CreatePrivateAccessChannel Create an Private access Channel for the Analytics instance. The operation is long-running and creates a new WorkRequest.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/CreatePrivateAccessChannel.go.html to see an example of how to use CreatePrivateAccessChannel API. A default retry strategy applies to this operation CreatePrivateAccessChannel()

func (AnalyticsClient) CreateVanityUrl 

func (client AnalyticsClient) CreateVanityUrl(ctx context.Context, request CreateVanityUrlRequest) (response CreateVanityUrlResponse, err error)

CreateVanityUrl Allows specifying a custom host name to be used to access the analytics instance. This requires prior setup of DNS entry and certificate for this host.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/CreateVanityUrl.go.html to see an example of how to use CreateVanityUrl API. A default retry strategy applies to this operation CreateVanityUrl()

func (AnalyticsClient) DeleteAnalyticsInstance 

func (client AnalyticsClient) DeleteAnalyticsInstance(ctx context.Context, request DeleteAnalyticsInstanceRequest) (response DeleteAnalyticsInstanceResponse, err error)

DeleteAnalyticsInstance Terminates the specified Analytics instance. The operation is long-running and creates a new WorkRequest.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/DeleteAnalyticsInstance.go.html to see an example of how to use DeleteAnalyticsInstance API. A default retry strategy applies to this operation DeleteAnalyticsInstance()

func (AnalyticsClient) DeletePrivateAccessChannel 

func (client AnalyticsClient) DeletePrivateAccessChannel(ctx context.Context, request DeletePrivateAccessChannelRequest) (response DeletePrivateAccessChannelResponse, err error)

DeletePrivateAccessChannel Delete an Analytics instance's Private access channel with the given unique identifier key.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/DeletePrivateAccessChannel.go.html to see an example of how to use DeletePrivateAccessChannel API. A default retry strategy applies to this operation DeletePrivateAccessChannel()

func (AnalyticsClient) DeleteVanityUrl 

func (client AnalyticsClient) DeleteVanityUrl(ctx context.Context, request DeleteVanityUrlRequest) (response DeleteVanityUrlResponse, err error)

DeleteVanityUrl Allows deleting a previously created vanity url.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/DeleteVanityUrl.go.html to see an example of how to use DeleteVanityUrl API. A default retry strategy applies to this operation DeleteVanityUrl()

func (AnalyticsClient) DeleteWorkRequest 

func (client AnalyticsClient) DeleteWorkRequest(ctx context.Context, request DeleteWorkRequestRequest) (response DeleteWorkRequestResponse, err error)

DeleteWorkRequest Cancel a work request that has not started yet.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/DeleteWorkRequest.go.html to see an example of how to use DeleteWorkRequest API.

func (AnalyticsClient) GetAnalyticsInstance 

func (client AnalyticsClient) GetAnalyticsInstance(ctx context.Context, request GetAnalyticsInstanceRequest) (response GetAnalyticsInstanceResponse, err error)

GetAnalyticsInstance Info for a specific Analytics instance.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/GetAnalyticsInstance.go.html to see an example of how to use GetAnalyticsInstance API. A default retry strategy applies to this operation GetAnalyticsInstance()

func (AnalyticsClient) GetPrivateAccessChannel 

func (client AnalyticsClient) GetPrivateAccessChannel(ctx context.Context, request GetPrivateAccessChannelRequest) (response GetPrivateAccessChannelResponse, err error)

GetPrivateAccessChannel Retrieve private access channel in the specified Analytics Instance.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/GetPrivateAccessChannel.go.html to see an example of how to use GetPrivateAccessChannel API. A default retry strategy applies to this operation GetPrivateAccessChannel()

func (AnalyticsClient) GetWorkRequest 

func (client AnalyticsClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)

GetWorkRequest Get the details of a work request.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()

func (AnalyticsClient) ListAnalyticsInstances 

func (client AnalyticsClient) ListAnalyticsInstances(ctx context.Context, request ListAnalyticsInstancesRequest) (response ListAnalyticsInstancesResponse, err error)

ListAnalyticsInstances List Analytics instances.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/ListAnalyticsInstances.go.html to see an example of how to use ListAnalyticsInstances API. A default retry strategy applies to this operation ListAnalyticsInstances()

func (AnalyticsClient) ListWorkRequestErrors 

func (client AnalyticsClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)

ListWorkRequestErrors Get the errors of a work request.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()

func (AnalyticsClient) ListWorkRequestLogs 

func (client AnalyticsClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)

ListWorkRequestLogs Get the logs of a work request.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()

func (AnalyticsClient) ListWorkRequests 

func (client AnalyticsClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)

ListWorkRequests List all work requests in a compartment.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()

func (AnalyticsClient) ScaleAnalyticsInstance 

func (client AnalyticsClient) ScaleAnalyticsInstance(ctx context.Context, request ScaleAnalyticsInstanceRequest) (response ScaleAnalyticsInstanceResponse, err error)

ScaleAnalyticsInstance Scale an Analytics instance up or down. The operation is long-running and creates a new WorkRequest.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/ScaleAnalyticsInstance.go.html to see an example of how to use ScaleAnalyticsInstance API. A default retry strategy applies to this operation ScaleAnalyticsInstance()

func (AnalyticsClient) SetKmsKey 

func (client AnalyticsClient) SetKmsKey(ctx context.Context, request SetKmsKeyRequest) (response SetKmsKeyResponse, err error)

SetKmsKey Encrypts the customer data of this Analytics instance using either a customer OCI Vault Key or Oracle managed default key.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/SetKmsKey.go.html to see an example of how to use SetKmsKey API. A default retry strategy applies to this operation SetKmsKey()

func (*AnalyticsClient) SetRegion 

func (client *AnalyticsClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (AnalyticsClient) StartAnalyticsInstance 

func (client AnalyticsClient) StartAnalyticsInstance(ctx context.Context, request StartAnalyticsInstanceRequest) (response StartAnalyticsInstanceResponse, err error)

StartAnalyticsInstance Starts the specified Analytics instance. The operation is long-running and creates a new WorkRequest.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/StartAnalyticsInstance.go.html to see an example of how to use StartAnalyticsInstance API. A default retry strategy applies to this operation StartAnalyticsInstance()

func (AnalyticsClient) StopAnalyticsInstance 

func (client AnalyticsClient) StopAnalyticsInstance(ctx context.Context, request StopAnalyticsInstanceRequest) (response StopAnalyticsInstanceResponse, err error)

StopAnalyticsInstance Stop the specified Analytics instance. The operation is long-running and creates a new WorkRequest.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/StopAnalyticsInstance.go.html to see an example of how to use StopAnalyticsInstance API. A default retry strategy applies to this operation StopAnalyticsInstance()

func (AnalyticsClient) UpdateAnalyticsInstance 

func (client AnalyticsClient) UpdateAnalyticsInstance(ctx context.Context, request UpdateAnalyticsInstanceRequest) (response UpdateAnalyticsInstanceResponse, err error)

UpdateAnalyticsInstance Updates certain fields of an Analytics instance. Fields that are not provided in the request will not be updated.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/UpdateAnalyticsInstance.go.html to see an example of how to use UpdateAnalyticsInstance API.

func (AnalyticsClient) UpdatePrivateAccessChannel 

func (client AnalyticsClient) UpdatePrivateAccessChannel(ctx context.Context, request UpdatePrivateAccessChannelRequest) (response UpdatePrivateAccessChannelResponse, err error)

UpdatePrivateAccessChannel Update the Private Access Channel with the given unique identifier key in the specified Analytics Instance.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/UpdatePrivateAccessChannel.go.html to see an example of how to use UpdatePrivateAccessChannel API. A default retry strategy applies to this operation UpdatePrivateAccessChannel()

func (AnalyticsClient) UpdateVanityUrl 

func (client AnalyticsClient) UpdateVanityUrl(ctx context.Context, request UpdateVanityUrlRequest) (response UpdateVanityUrlResponse, err error)

UpdateVanityUrl Allows uploading a new certificate for a vanity url, which will have to be done when the current certificate is expiring.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/UpdateVanityUrl.go.html to see an example of how to use UpdateVanityUrl API. A default retry strategy applies to this operation UpdateVanityUrl()

type AnalyticsInstance 

type AnalyticsInstance struct {

	// The resource OCID.
	Id *string `mandatory:"true" json:"id"`

	// The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.
	Name *string `mandatory:"true" json:"name"`

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The current state of an instance.
	LifecycleState AnalyticsInstanceLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Analytics feature set.
	FeatureSet FeatureSetEnum `mandatory:"true" json:"featureSet"`

	Capacity *Capacity `mandatory:"true" json:"capacity"`

	NetworkEndpointDetails NetworkEndpointDetails `mandatory:"true" json:"networkEndpointDetails"`

	// The date and time the instance was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// Optional description.
	Description *string `mandatory:"false" json:"description"`

	// The license used for the service.
	LicenseType LicenseTypeEnum `mandatory:"false" json:"licenseType,omitempty"`

	// Email address receiving notifications.
	EmailNotification *string `mandatory:"false" json:"emailNotification"`

	// Map of PrivateAccessChannel unique identifier key as KEY and PrivateAccessChannel Object as VALUE.
	PrivateAccessChannels map[string]PrivateAccessChannel `mandatory:"false" json:"privateAccessChannels"`

	// Map of VanityUrl unique identifier key as KEY and VanityUrl Object as VALUE.
	VanityUrlDetails map[string]VanityUrlDetails `mandatory:"false" json:"vanityUrlDetails"`

	// URL of the Analytics service.
	ServiceUrl *string `mandatory:"false" json:"serviceUrl"`

	// Defined tags for this resource. Each key is predefined and scoped to a
	// namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the OCI Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates Oracle managed default encryption.
	KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`

	// The date and time the instance was last updated (in the format defined by RFC3339).
	// This timestamp represents updates made through this API. External events do not
	// influence it.
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}

AnalyticsInstance Analytics Instance metadata.

func (AnalyticsInstance) String 

func (m AnalyticsInstance) String() string

func (*AnalyticsInstance) UnmarshalJSON 

func (m *AnalyticsInstance) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (AnalyticsInstance) ValidateEnumValue 

func (m AnalyticsInstance) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type AnalyticsInstanceLifecycleStateEnum 

type AnalyticsInstanceLifecycleStateEnum string

AnalyticsInstanceLifecycleStateEnum Enum with underlying type: string 

const (
	AnalyticsInstanceLifecycleStateActive   AnalyticsInstanceLifecycleStateEnum = "ACTIVE"
	AnalyticsInstanceLifecycleStateCreating AnalyticsInstanceLifecycleStateEnum = "CREATING"
	AnalyticsInstanceLifecycleStateDeleted  AnalyticsInstanceLifecycleStateEnum = "DELETED"
	AnalyticsInstanceLifecycleStateDeleting AnalyticsInstanceLifecycleStateEnum = "DELETING"
	AnalyticsInstanceLifecycleStateFailed   AnalyticsInstanceLifecycleStateEnum = "FAILED"
	AnalyticsInstanceLifecycleStateInactive AnalyticsInstanceLifecycleStateEnum = "INACTIVE"
	AnalyticsInstanceLifecycleStateUpdating AnalyticsInstanceLifecycleStateEnum = "UPDATING"
)

Set of constants representing the allowable values for AnalyticsInstanceLifecycleStateEnum

func GetAnalyticsInstanceLifecycleStateEnumValues 

func GetAnalyticsInstanceLifecycleStateEnumValues() []AnalyticsInstanceLifecycleStateEnum

GetAnalyticsInstanceLifecycleStateEnumValues Enumerates the set of values for AnalyticsInstanceLifecycleStateEnum

func GetMappingAnalyticsInstanceLifecycleStateEnum 

func GetMappingAnalyticsInstanceLifecycleStateEnum(val string) (AnalyticsInstanceLifecycleStateEnum, bool)

GetMappingAnalyticsInstanceLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type AnalyticsInstanceSummary 

type AnalyticsInstanceSummary struct {

	// The resource OCID.
	Id *string `mandatory:"true" json:"id"`

	// The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.
	Name *string `mandatory:"true" json:"name"`

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The current state of an instance.
	LifecycleState AnalyticsInstanceLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Analytics feature set.
	FeatureSet FeatureSetEnum `mandatory:"true" json:"featureSet"`

	Capacity *Capacity `mandatory:"true" json:"capacity"`

	NetworkEndpointDetails NetworkEndpointDetails `mandatory:"true" json:"networkEndpointDetails"`

	// The date and time the instance was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// Optional description.
	Description *string `mandatory:"false" json:"description"`

	// The license used for the service.
	LicenseType LicenseTypeEnum `mandatory:"false" json:"licenseType,omitempty"`

	// Email address receiving notifications.
	EmailNotification *string `mandatory:"false" json:"emailNotification"`

	// URL of the Analytics service.
	ServiceUrl *string `mandatory:"false" json:"serviceUrl"`

	// The date and time the instance was last updated (in the format defined by RFC3339).
	// This timestamp represents updates made through this API. External events do not
	// influence it.
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}

AnalyticsInstanceSummary Analytics Instance metadata (summary view).

func (AnalyticsInstanceSummary) String 

func (m AnalyticsInstanceSummary) String() string

func (*AnalyticsInstanceSummary) UnmarshalJSON 

func (m *AnalyticsInstanceSummary) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (AnalyticsInstanceSummary) ValidateEnumValue 

func (m AnalyticsInstanceSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type Capacity 

type Capacity struct {

	// The capacity model to use.
	CapacityType CapacityTypeEnum `mandatory:"true" json:"capacityType"`

	// The capacity value selected (OLPU count, number of users, ...etc...). This parameter affects the
	// number of CPUs, amount of memory or other resources allocated to the instance.
	CapacityValue *int `mandatory:"true" json:"capacityValue"`
}

Capacity Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).

func (Capacity) String 

func (m Capacity) String() string

func (Capacity) ValidateEnumValue 

func (m Capacity) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CapacityTypeEnum 

type CapacityTypeEnum string

CapacityTypeEnum Enum with underlying type: string 

const (
	CapacityTypeOlpuCount CapacityTypeEnum = "OLPU_COUNT"
	CapacityTypeUserCount CapacityTypeEnum = "USER_COUNT"
)

Set of constants representing the allowable values for CapacityTypeEnum

func GetCapacityTypeEnumValues 

func GetCapacityTypeEnumValues() []CapacityTypeEnum

GetCapacityTypeEnumValues Enumerates the set of values for CapacityTypeEnum

func GetMappingCapacityTypeEnum 

func GetMappingCapacityTypeEnum(val string) (CapacityTypeEnum, bool)

GetMappingCapacityTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type ChangeAnalyticsInstanceCompartmentRequest 

type ChangeAnalyticsInstanceCompartmentRequest struct {

	// The OCID of the AnalyticsInstance.
	AnalyticsInstanceId *string `mandatory:"true" contributesTo:"path" name:"analyticsInstanceId"`

	// Input payload to move the resource to a different compartment.
	ChangeCompartmentDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ChangeAnalyticsInstanceCompartmentRequest wrapper for the ChangeAnalyticsInstanceCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/ChangeAnalyticsInstanceCompartment.go.html to see an example of how to use ChangeAnalyticsInstanceCompartmentRequest.

func (ChangeAnalyticsInstanceCompartmentRequest) BinaryRequestBody 

func (request ChangeAnalyticsInstanceCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeAnalyticsInstanceCompartmentRequest) HTTPRequest 

func (request ChangeAnalyticsInstanceCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeAnalyticsInstanceCompartmentRequest) RetryPolicy 

func (request ChangeAnalyticsInstanceCompartmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeAnalyticsInstanceCompartmentRequest) String 

func (request ChangeAnalyticsInstanceCompartmentRequest) String() string

func (ChangeAnalyticsInstanceCompartmentRequest) ValidateEnumValue 

func (request ChangeAnalyticsInstanceCompartmentRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeAnalyticsInstanceCompartmentResponse 

type ChangeAnalyticsInstanceCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// The OCID of the work request. Use GetWorkRequest with this ID to track the status
	// of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

ChangeAnalyticsInstanceCompartmentResponse wrapper for the ChangeAnalyticsInstanceCompartment operation

func (ChangeAnalyticsInstanceCompartmentResponse) HTTPResponse 

func (response ChangeAnalyticsInstanceCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeAnalyticsInstanceCompartmentResponse) String 

func (response ChangeAnalyticsInstanceCompartmentResponse) String() string

type ChangeAnalyticsInstanceNetworkEndpointDetails 

type ChangeAnalyticsInstanceNetworkEndpointDetails struct {
	NetworkEndpointDetails NetworkEndpointDetails `mandatory:"true" json:"networkEndpointDetails"`
}

ChangeAnalyticsInstanceNetworkEndpointDetails Input payload to update an Analytics instance endpoint details.

func (ChangeAnalyticsInstanceNetworkEndpointDetails) String 

func (m ChangeAnalyticsInstanceNetworkEndpointDetails) String() string

func (*ChangeAnalyticsInstanceNetworkEndpointDetails) UnmarshalJSON 

func (m *ChangeAnalyticsInstanceNetworkEndpointDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (ChangeAnalyticsInstanceNetworkEndpointDetails) ValidateEnumValue 

func (m ChangeAnalyticsInstanceNetworkEndpointDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeAnalyticsInstanceNetworkEndpointRequest 

type ChangeAnalyticsInstanceNetworkEndpointRequest struct {

	// The OCID of the AnalyticsInstance.
	AnalyticsInstanceId *string `mandatory:"true" contributesTo:"path" name:"analyticsInstanceId"`

	// Input payload for changing an Analytics instance network endpoint.
	ChangeAnalyticsInstanceNetworkEndpointDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ChangeAnalyticsInstanceNetworkEndpointRequest wrapper for the ChangeAnalyticsInstanceNetworkEndpoint operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/ChangeAnalyticsInstanceNetworkEndpoint.go.html to see an example of how to use ChangeAnalyticsInstanceNetworkEndpointRequest.

func (ChangeAnalyticsInstanceNetworkEndpointRequest) BinaryRequestBody 

func (request ChangeAnalyticsInstanceNetworkEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeAnalyticsInstanceNetworkEndpointRequest) HTTPRequest 

func (request ChangeAnalyticsInstanceNetworkEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeAnalyticsInstanceNetworkEndpointRequest) RetryPolicy 

func (request ChangeAnalyticsInstanceNetworkEndpointRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeAnalyticsInstanceNetworkEndpointRequest) String 

func (request ChangeAnalyticsInstanceNetworkEndpointRequest) String() string

func (ChangeAnalyticsInstanceNetworkEndpointRequest) ValidateEnumValue 

func (request ChangeAnalyticsInstanceNetworkEndpointRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeAnalyticsInstanceNetworkEndpointResponse 

type ChangeAnalyticsInstanceNetworkEndpointResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// The OCID of the work request. Use GetWorkRequest with this ID to track the status
	// of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

ChangeAnalyticsInstanceNetworkEndpointResponse wrapper for the ChangeAnalyticsInstanceNetworkEndpoint operation

func (ChangeAnalyticsInstanceNetworkEndpointResponse) HTTPResponse 

func (response ChangeAnalyticsInstanceNetworkEndpointResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeAnalyticsInstanceNetworkEndpointResponse) String 

func (response ChangeAnalyticsInstanceNetworkEndpointResponse) String() string

type ChangeCompartmentDetails 

type ChangeCompartmentDetails struct {

	// The OCID of the new compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeCompartmentDetails Input payload to change a resource's compartment.

func (ChangeCompartmentDetails) String 

func (m ChangeCompartmentDetails) String() string

func (ChangeCompartmentDetails) ValidateEnumValue 

func (m ChangeCompartmentDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateAnalyticsInstanceDetails 

type CreateAnalyticsInstanceDetails struct {

	// The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed.
	Name *string `mandatory:"true" json:"name"`

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// Analytics feature set.
	FeatureSet FeatureSetEnum `mandatory:"true" json:"featureSet"`

	Capacity *Capacity `mandatory:"true" json:"capacity"`

	// The license used for the service.
	LicenseType LicenseTypeEnum `mandatory:"true" json:"licenseType"`

	// Optional description.
	Description *string `mandatory:"false" json:"description"`

	// Email address receiving notifications.
	EmailNotification *string `mandatory:"false" json:"emailNotification"`

	NetworkEndpointDetails NetworkEndpointDetails `mandatory:"false" json:"networkEndpointDetails"`

	// IDCS access token identifying a stripe and service administrator user.
	IdcsAccessToken *string `mandatory:"false" json:"idcsAccessToken"`

	// Defined tags for this resource. Each key is predefined and scoped to a
	// namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the OCI Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates Oracle managed default encryption.
	KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
}

CreateAnalyticsInstanceDetails Input payload to create an Anaytics instance.

func (CreateAnalyticsInstanceDetails) String 

func (m CreateAnalyticsInstanceDetails) String() string

func (*CreateAnalyticsInstanceDetails) UnmarshalJSON 

func (m *CreateAnalyticsInstanceDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (CreateAnalyticsInstanceDetails) ValidateEnumValue 

func (m CreateAnalyticsInstanceDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateAnalyticsInstanceRequest 

type CreateAnalyticsInstanceRequest struct {

	// Analytics Instance details.
	CreateAnalyticsInstanceDetails `contributesTo:"body"`

	// Unique identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

CreateAnalyticsInstanceRequest wrapper for the CreateAnalyticsInstance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/CreateAnalyticsInstance.go.html to see an example of how to use CreateAnalyticsInstanceRequest.

func (CreateAnalyticsInstanceRequest) BinaryRequestBody 

func (request CreateAnalyticsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateAnalyticsInstanceRequest) HTTPRequest 

func (request CreateAnalyticsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateAnalyticsInstanceRequest) RetryPolicy 

func (request CreateAnalyticsInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateAnalyticsInstanceRequest) String 

func (request CreateAnalyticsInstanceRequest) String() string

func (CreateAnalyticsInstanceRequest) ValidateEnumValue 

func (request CreateAnalyticsInstanceRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateAnalyticsInstanceResponse 

type CreateAnalyticsInstanceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The AnalyticsInstance instance
	AnalyticsInstance `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// The OCID of the work request. Use GetWorkRequest with this ID to track the status
	// of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// The full URI of the resource.
	Location *string `presentIn:"header" name:"location"`
}

CreateAnalyticsInstanceResponse wrapper for the CreateAnalyticsInstance operation

func (CreateAnalyticsInstanceResponse) HTTPResponse 

func (response CreateAnalyticsInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateAnalyticsInstanceResponse) String 

func (response CreateAnalyticsInstanceResponse) String() string

type CreatePrivateAccessChannelDetails 

type CreatePrivateAccessChannelDetails struct {

	// Display Name of the Private Access Channel.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// OCID of the customer VCN peered with private access channel.
	VcnId *string `mandatory:"true" json:"vcnId"`

	// OCID of the customer subnet connected to private access channel.
	SubnetId *string `mandatory:"true" json:"subnetId"`

	// List of Private Source DNS zones registered with Private Access Channel,
	// where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance.
	// Min of 1 is required and Max of 30 Private Source DNS zones can be registered.
	PrivateSourceDnsZones []PrivateSourceDnsZone `mandatory:"true" json:"privateSourceDnsZones"`

	// List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.
	PrivateSourceScanHosts []PrivateSourceScanHost `mandatory:"false" json:"privateSourceScanHosts"`

	// Network Security Group OCIDs for an Analytics instance.
	NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`
}

CreatePrivateAccessChannelDetails Input payload to create a Private Access Channel.

func (CreatePrivateAccessChannelDetails) String 

func (m CreatePrivateAccessChannelDetails) String() string

func (CreatePrivateAccessChannelDetails) ValidateEnumValue 

func (m CreatePrivateAccessChannelDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreatePrivateAccessChannelRequest 

type CreatePrivateAccessChannelRequest struct {

	// The OCID of the AnalyticsInstance.
	AnalyticsInstanceId *string `mandatory:"true" contributesTo:"path" name:"analyticsInstanceId"`

	// Input payload for creating a private access channel for an Analytics instance.
	CreatePrivateAccessChannelDetails `contributesTo:"body"`

	// Unique identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

CreatePrivateAccessChannelRequest wrapper for the CreatePrivateAccessChannel operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/CreatePrivateAccessChannel.go.html to see an example of how to use CreatePrivateAccessChannelRequest.

func (CreatePrivateAccessChannelRequest) BinaryRequestBody 

func (request CreatePrivateAccessChannelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreatePrivateAccessChannelRequest) HTTPRequest 

func (request CreatePrivateAccessChannelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreatePrivateAccessChannelRequest) RetryPolicy 

func (request CreatePrivateAccessChannelRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreatePrivateAccessChannelRequest) String 

func (request CreatePrivateAccessChannelRequest) String() string

func (CreatePrivateAccessChannelRequest) ValidateEnumValue 

func (request CreatePrivateAccessChannelRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreatePrivateAccessChannelResponse 

type CreatePrivateAccessChannelResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// The OCID of the work request. Use GetWorkRequest with this ID to track the status
	// of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

CreatePrivateAccessChannelResponse wrapper for the CreatePrivateAccessChannel operation

func (CreatePrivateAccessChannelResponse) HTTPResponse 

func (response CreatePrivateAccessChannelResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreatePrivateAccessChannelResponse) String 

func (response CreatePrivateAccessChannelResponse) String() string

type CreateVanityUrlDetails 

type CreateVanityUrlDetails struct {

	// List of fully qualified hostnames supported by this vanity URL definition (max of 3).
	Hosts []string `mandatory:"true" json:"hosts"`

	// PEM Private key for HTTPS connections.
	PrivateKey *string `mandatory:"true" json:"privateKey"`

	// PEM certificate for HTTPS connections.
	PublicCertificate *string `mandatory:"true" json:"publicCertificate"`

	// PEM CA certificate(s) for HTTPS connections. This may include multiple PEM certificates.
	CaCertificate *string `mandatory:"true" json:"caCertificate"`

	// Optional description.
	Description *string `mandatory:"false" json:"description"`

	// Passphrase for the PEM Private key (if any).
	Passphrase *string `mandatory:"false" json:"passphrase"`
}

CreateVanityUrlDetails Input payload to create a vanity url.

func (CreateVanityUrlDetails) String 

func (m CreateVanityUrlDetails) String() string

func (CreateVanityUrlDetails) ValidateEnumValue 

func (m CreateVanityUrlDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateVanityUrlRequest 

type CreateVanityUrlRequest struct {

	// The OCID of the AnalyticsInstance.
	AnalyticsInstanceId *string `mandatory:"true" contributesTo:"path" name:"analyticsInstanceId"`

	// Vanity url details.
	CreateVanityUrlDetails `contributesTo:"body"`

	// Unique identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

CreateVanityUrlRequest wrapper for the CreateVanityUrl operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/CreateVanityUrl.go.html to see an example of how to use CreateVanityUrlRequest.

func (CreateVanityUrlRequest) BinaryRequestBody 

func (request CreateVanityUrlRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateVanityUrlRequest) HTTPRequest 

func (request CreateVanityUrlRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateVanityUrlRequest) RetryPolicy 

func (request CreateVanityUrlRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateVanityUrlRequest) String 

func (request CreateVanityUrlRequest) String() string

func (CreateVanityUrlRequest) ValidateEnumValue 

func (request CreateVanityUrlRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateVanityUrlResponse 

type CreateVanityUrlResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// The OCID of the work request. Use GetWorkRequest with this ID to track the status
	// of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

CreateVanityUrlResponse wrapper for the CreateVanityUrl operation

func (CreateVanityUrlResponse) HTTPResponse 

func (response CreateVanityUrlResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateVanityUrlResponse) String 

func (response CreateVanityUrlResponse) String() string

type DeleteAnalyticsInstanceRequest 

type DeleteAnalyticsInstanceRequest struct {

	// The OCID of the AnalyticsInstance.
	AnalyticsInstanceId *string `mandatory:"true" contributesTo:"path" name:"analyticsInstanceId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

DeleteAnalyticsInstanceRequest wrapper for the DeleteAnalyticsInstance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/DeleteAnalyticsInstance.go.html to see an example of how to use DeleteAnalyticsInstanceRequest.

func (DeleteAnalyticsInstanceRequest) BinaryRequestBody 

func (request DeleteAnalyticsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteAnalyticsInstanceRequest) HTTPRequest 

func (request DeleteAnalyticsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteAnalyticsInstanceRequest) RetryPolicy 

func (request DeleteAnalyticsInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteAnalyticsInstanceRequest) String 

func (request DeleteAnalyticsInstanceRequest) String() string

func (DeleteAnalyticsInstanceRequest) ValidateEnumValue 

func (request DeleteAnalyticsInstanceRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DeleteAnalyticsInstanceResponse 

type DeleteAnalyticsInstanceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// The OCID of the work request. Use GetWorkRequest with this ID to track the status
	// of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

DeleteAnalyticsInstanceResponse wrapper for the DeleteAnalyticsInstance operation

func (DeleteAnalyticsInstanceResponse) HTTPResponse 

func (response DeleteAnalyticsInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteAnalyticsInstanceResponse) String 

func (response DeleteAnalyticsInstanceResponse) String() string

type DeletePrivateAccessChannelRequest 

type DeletePrivateAccessChannelRequest struct {

	// The unique identifier key of the Private Access Channel.
	PrivateAccessChannelKey *string `mandatory:"true" contributesTo:"path" name:"privateAccessChannelKey"`

	// The OCID of the AnalyticsInstance.
	AnalyticsInstanceId *string `mandatory:"true" contributesTo:"path" name:"analyticsInstanceId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

DeletePrivateAccessChannelRequest wrapper for the DeletePrivateAccessChannel operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/DeletePrivateAccessChannel.go.html to see an example of how to use DeletePrivateAccessChannelRequest.

func (DeletePrivateAccessChannelRequest) BinaryRequestBody 

func (request DeletePrivateAccessChannelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeletePrivateAccessChannelRequest) HTTPRequest 

func (request DeletePrivateAccessChannelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeletePrivateAccessChannelRequest) RetryPolicy 

func (request DeletePrivateAccessChannelRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeletePrivateAccessChannelRequest) String 

func (request DeletePrivateAccessChannelRequest) String() string

func (DeletePrivateAccessChannelRequest) ValidateEnumValue 

func (request DeletePrivateAccessChannelRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DeletePrivateAccessChannelResponse 

type DeletePrivateAccessChannelResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// The OCID of the work request. Use GetWorkRequest with this ID to track the status
	// of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

DeletePrivateAccessChannelResponse wrapper for the DeletePrivateAccessChannel operation

func (DeletePrivateAccessChannelResponse) HTTPResponse 

func (response DeletePrivateAccessChannelResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeletePrivateAccessChannelResponse) String 

func (response DeletePrivateAccessChannelResponse) String() string

type DeleteVanityUrlRequest 

type DeleteVanityUrlRequest struct {

	// The OCID of the AnalyticsInstance.
	AnalyticsInstanceId *string `mandatory:"true" contributesTo:"path" name:"analyticsInstanceId"`

	// Specify unique identifier key of a vanity url to update or delete.
	VanityUrlKey *string `mandatory:"true" contributesTo:"path" name:"vanityUrlKey"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

DeleteVanityUrlRequest wrapper for the DeleteVanityUrl operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/DeleteVanityUrl.go.html to see an example of how to use DeleteVanityUrlRequest.

func (DeleteVanityUrlRequest) BinaryRequestBody 

func (request DeleteVanityUrlRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteVanityUrlRequest) HTTPRequest 

func (request DeleteVanityUrlRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteVanityUrlRequest) RetryPolicy 

func (request DeleteVanityUrlRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteVanityUrlRequest) String 

func (request DeleteVanityUrlRequest) String() string

func (DeleteVanityUrlRequest) ValidateEnumValue 

func (request DeleteVanityUrlRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DeleteVanityUrlResponse 

type DeleteVanityUrlResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// The OCID of the work request. Use GetWorkRequest with this ID to track the status
	// of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

DeleteVanityUrlResponse wrapper for the DeleteVanityUrl operation

func (DeleteVanityUrlResponse) HTTPResponse 

func (response DeleteVanityUrlResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteVanityUrlResponse) String 

func (response DeleteVanityUrlResponse) String() string

type DeleteWorkRequestRequest 

type DeleteWorkRequestRequest struct {

	// The OCID of the work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

DeleteWorkRequestRequest wrapper for the DeleteWorkRequest operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/DeleteWorkRequest.go.html to see an example of how to use DeleteWorkRequestRequest.

func (DeleteWorkRequestRequest) BinaryRequestBody 

func (request DeleteWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteWorkRequestRequest) HTTPRequest 

func (request DeleteWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteWorkRequestRequest) RetryPolicy 

func (request DeleteWorkRequestRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteWorkRequestRequest) String 

func (request DeleteWorkRequestRequest) String() string

func (DeleteWorkRequestRequest) ValidateEnumValue 

func (request DeleteWorkRequestRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DeleteWorkRequestResponse 

type DeleteWorkRequestResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteWorkRequestResponse wrapper for the DeleteWorkRequest operation

func (DeleteWorkRequestResponse) HTTPResponse 

func (response DeleteWorkRequestResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteWorkRequestResponse) String 

func (response DeleteWorkRequestResponse) String() string

type FeatureSetEnum 

type FeatureSetEnum string

FeatureSetEnum Enum with underlying type: string 

const (
	FeatureSetSelfServiceAnalytics FeatureSetEnum = "SELF_SERVICE_ANALYTICS"
	FeatureSetEnterpriseAnalytics  FeatureSetEnum = "ENTERPRISE_ANALYTICS"
)

Set of constants representing the allowable values for FeatureSetEnum

func GetFeatureSetEnumValues 

func GetFeatureSetEnumValues() []FeatureSetEnum

GetFeatureSetEnumValues Enumerates the set of values for FeatureSetEnum

func GetMappingFeatureSetEnum 

func GetMappingFeatureSetEnum(val string) (FeatureSetEnum, bool)

GetMappingFeatureSetEnum performs case Insensitive comparison on enum value and return the desired enum

type GetAnalyticsInstanceRequest 

type GetAnalyticsInstanceRequest struct {

	// The OCID of the AnalyticsInstance.
	AnalyticsInstanceId *string `mandatory:"true" contributesTo:"path" name:"analyticsInstanceId"`

	// Unique identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

GetAnalyticsInstanceRequest wrapper for the GetAnalyticsInstance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/GetAnalyticsInstance.go.html to see an example of how to use GetAnalyticsInstanceRequest.

func (GetAnalyticsInstanceRequest) BinaryRequestBody 

func (request GetAnalyticsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetAnalyticsInstanceRequest) HTTPRequest 

func (request GetAnalyticsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetAnalyticsInstanceRequest) RetryPolicy 

func (request GetAnalyticsInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetAnalyticsInstanceRequest) String 

func (request GetAnalyticsInstanceRequest) String() string

func (GetAnalyticsInstanceRequest) ValidateEnumValue 

func (request GetAnalyticsInstanceRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetAnalyticsInstanceResponse 

type GetAnalyticsInstanceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The AnalyticsInstance instance
	AnalyticsInstance `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetAnalyticsInstanceResponse wrapper for the GetAnalyticsInstance operation

func (GetAnalyticsInstanceResponse) HTTPResponse 

func (response GetAnalyticsInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetAnalyticsInstanceResponse) String 

func (response GetAnalyticsInstanceResponse) String() string

type GetPrivateAccessChannelRequest 

type GetPrivateAccessChannelRequest struct {

	// The unique identifier key of the Private Access Channel.
	PrivateAccessChannelKey *string `mandatory:"true" contributesTo:"path" name:"privateAccessChannelKey"`

	// The OCID of the AnalyticsInstance.
	AnalyticsInstanceId *string `mandatory:"true" contributesTo:"path" name:"analyticsInstanceId"`

	// Unique identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

GetPrivateAccessChannelRequest wrapper for the GetPrivateAccessChannel operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/GetPrivateAccessChannel.go.html to see an example of how to use GetPrivateAccessChannelRequest.

func (GetPrivateAccessChannelRequest) BinaryRequestBody 

func (request GetPrivateAccessChannelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetPrivateAccessChannelRequest) HTTPRequest 

func (request GetPrivateAccessChannelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetPrivateAccessChannelRequest) RetryPolicy 

func (request GetPrivateAccessChannelRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetPrivateAccessChannelRequest) String 

func (request GetPrivateAccessChannelRequest) String() string

func (GetPrivateAccessChannelRequest) ValidateEnumValue 

func (request GetPrivateAccessChannelRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetPrivateAccessChannelResponse 

type GetPrivateAccessChannelResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The PrivateAccessChannel instance
	PrivateAccessChannel `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetPrivateAccessChannelResponse wrapper for the GetPrivateAccessChannel operation

func (GetPrivateAccessChannelResponse) HTTPResponse 

func (response GetPrivateAccessChannelResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetPrivateAccessChannelResponse) String 

func (response GetPrivateAccessChannelResponse) String() string

type GetWorkRequestRequest 

type GetWorkRequestRequest struct {

	// The OCID of the work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// Unique identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.

func (GetWorkRequestRequest) BinaryRequestBody 

func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest 

func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy 

func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetWorkRequestRequest) String 

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue 

func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetWorkRequestResponse 

type GetWorkRequestResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The WorkRequest instance
	WorkRequest `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// The number of seconds a client should wait before polling this endpoint again.
	RetryAfter *int `presentIn:"header" name:"retry-after"`
}

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse 

func (response GetWorkRequestResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String 

func (response GetWorkRequestResponse) String() string

type LicenseTypeEnum 

type LicenseTypeEnum string

LicenseTypeEnum Enum with underlying type: string 

const (
	LicenseTypeLicenseIncluded     LicenseTypeEnum = "LICENSE_INCLUDED"
	LicenseTypeBringYourOwnLicense LicenseTypeEnum = "BRING_YOUR_OWN_LICENSE"
)

Set of constants representing the allowable values for LicenseTypeEnum

func GetLicenseTypeEnumValues 

func GetLicenseTypeEnumValues() []LicenseTypeEnum

GetLicenseTypeEnumValues Enumerates the set of values for LicenseTypeEnum

func GetMappingLicenseTypeEnum 

func GetMappingLicenseTypeEnum(val string) (LicenseTypeEnum, bool)

GetMappingLicenseTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type ListAnalyticsInstancesCapacityTypeEnum 

type ListAnalyticsInstancesCapacityTypeEnum string

ListAnalyticsInstancesCapacityTypeEnum Enum with underlying type: string 

const (
	ListAnalyticsInstancesCapacityTypeOlpuCount ListAnalyticsInstancesCapacityTypeEnum = "OLPU_COUNT"
	ListAnalyticsInstancesCapacityTypeUserCount ListAnalyticsInstancesCapacityTypeEnum = "USER_COUNT"
)

Set of constants representing the allowable values for ListAnalyticsInstancesCapacityTypeEnum

func GetListAnalyticsInstancesCapacityTypeEnumValues 

func GetListAnalyticsInstancesCapacityTypeEnumValues() []ListAnalyticsInstancesCapacityTypeEnum

GetListAnalyticsInstancesCapacityTypeEnumValues Enumerates the set of values for ListAnalyticsInstancesCapacityTypeEnum

func GetMappingListAnalyticsInstancesCapacityTypeEnum 

func GetMappingListAnalyticsInstancesCapacityTypeEnum(val string) (ListAnalyticsInstancesCapacityTypeEnum, bool)

GetMappingListAnalyticsInstancesCapacityTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type ListAnalyticsInstancesFeatureSetEnum 

type ListAnalyticsInstancesFeatureSetEnum string

ListAnalyticsInstancesFeatureSetEnum Enum with underlying type: string 

const (
	ListAnalyticsInstancesFeatureSetSelfServiceAnalytics ListAnalyticsInstancesFeatureSetEnum = "SELF_SERVICE_ANALYTICS"
	ListAnalyticsInstancesFeatureSetEnterpriseAnalytics  ListAnalyticsInstancesFeatureSetEnum = "ENTERPRISE_ANALYTICS"
)

Set of constants representing the allowable values for ListAnalyticsInstancesFeatureSetEnum

func GetListAnalyticsInstancesFeatureSetEnumValues 

func GetListAnalyticsInstancesFeatureSetEnumValues() []ListAnalyticsInstancesFeatureSetEnum

GetListAnalyticsInstancesFeatureSetEnumValues Enumerates the set of values for ListAnalyticsInstancesFeatureSetEnum

func GetMappingListAnalyticsInstancesFeatureSetEnum 

func GetMappingListAnalyticsInstancesFeatureSetEnum(val string) (ListAnalyticsInstancesFeatureSetEnum, bool)

GetMappingListAnalyticsInstancesFeatureSetEnum performs case Insensitive comparison on enum value and return the desired enum

type ListAnalyticsInstancesLifecycleStateEnum 

type ListAnalyticsInstancesLifecycleStateEnum string

ListAnalyticsInstancesLifecycleStateEnum Enum with underlying type: string 

const (
	ListAnalyticsInstancesLifecycleStateActive   ListAnalyticsInstancesLifecycleStateEnum = "ACTIVE"
	ListAnalyticsInstancesLifecycleStateCreating ListAnalyticsInstancesLifecycleStateEnum = "CREATING"
	ListAnalyticsInstancesLifecycleStateDeleted  ListAnalyticsInstancesLifecycleStateEnum = "DELETED"
	ListAnalyticsInstancesLifecycleStateDeleting ListAnalyticsInstancesLifecycleStateEnum = "DELETING"
	ListAnalyticsInstancesLifecycleStateFailed   ListAnalyticsInstancesLifecycleStateEnum = "FAILED"
	ListAnalyticsInstancesLifecycleStateInactive ListAnalyticsInstancesLifecycleStateEnum = "INACTIVE"
	ListAnalyticsInstancesLifecycleStateUpdating ListAnalyticsInstancesLifecycleStateEnum = "UPDATING"
)

Set of constants representing the allowable values for ListAnalyticsInstancesLifecycleStateEnum

func GetListAnalyticsInstancesLifecycleStateEnumValues 

func GetListAnalyticsInstancesLifecycleStateEnumValues() []ListAnalyticsInstancesLifecycleStateEnum

GetListAnalyticsInstancesLifecycleStateEnumValues Enumerates the set of values for ListAnalyticsInstancesLifecycleStateEnum

func GetMappingListAnalyticsInstancesLifecycleStateEnum 

func GetMappingListAnalyticsInstancesLifecycleStateEnum(val string) (ListAnalyticsInstancesLifecycleStateEnum, bool)

GetMappingListAnalyticsInstancesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type ListAnalyticsInstancesRequest 

type ListAnalyticsInstancesRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// Unique identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A filter to return only resources that match the given name exactly.
	Name *string `mandatory:"false" contributesTo:"query" name:"name"`

	// A filter to only return resources matching the capacity type enum. Values are
	// case-insensitive.
	CapacityType ListAnalyticsInstancesCapacityTypeEnum `mandatory:"false" contributesTo:"query" name:"capacityType" omitEmpty:"true"`

	// A filter to only return resources matching the feature set. Values are
	// case-insensitive.
	FeatureSet ListAnalyticsInstancesFeatureSetEnum `mandatory:"false" contributesTo:"query" name:"featureSet" omitEmpty:"true"`

	// A filter to only return resources matching the lifecycle state. The state
	// value is case-insensitive.
	LifecycleState ListAnalyticsInstancesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// For list pagination. The maximum number of results per page, or items to return in a paginated
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// For list pagination. The value of the `opc-next-page` response header from the previous "List"
	// call. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The field to sort by (one column only). Default sort order is
	// ascending exception of `timeCreated` column (descending).
	SortBy ListAnalyticsInstancesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListAnalyticsInstancesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListAnalyticsInstancesRequest wrapper for the ListAnalyticsInstances operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/ListAnalyticsInstances.go.html to see an example of how to use ListAnalyticsInstancesRequest.

func (ListAnalyticsInstancesRequest) BinaryRequestBody 

func (request ListAnalyticsInstancesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListAnalyticsInstancesRequest) HTTPRequest 

func (request ListAnalyticsInstancesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListAnalyticsInstancesRequest) RetryPolicy 

func (request ListAnalyticsInstancesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListAnalyticsInstancesRequest) String 

func (request ListAnalyticsInstancesRequest) String() string

func (ListAnalyticsInstancesRequest) ValidateEnumValue 

func (request ListAnalyticsInstancesRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListAnalyticsInstancesResponse 

type ListAnalyticsInstancesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []AnalyticsInstanceSummary instances
	Items []AnalyticsInstanceSummary `presentIn:"body"`

	// For list pagination. When this header appears in the response, additional pages
	// of results remain. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListAnalyticsInstancesResponse wrapper for the ListAnalyticsInstances operation

func (ListAnalyticsInstancesResponse) HTTPResponse 

func (response ListAnalyticsInstancesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListAnalyticsInstancesResponse) String 

func (response ListAnalyticsInstancesResponse) String() string

type ListAnalyticsInstancesSortByEnum 

type ListAnalyticsInstancesSortByEnum string

ListAnalyticsInstancesSortByEnum Enum with underlying type: string 

const (
	ListAnalyticsInstancesSortByCapacitytype   ListAnalyticsInstancesSortByEnum = "capacityType"
	ListAnalyticsInstancesSortByCapacityvalue  ListAnalyticsInstancesSortByEnum = "capacityValue"
	ListAnalyticsInstancesSortByFeatureset     ListAnalyticsInstancesSortByEnum = "featureSet"
	ListAnalyticsInstancesSortByLifecyclestate ListAnalyticsInstancesSortByEnum = "lifecycleState"
	ListAnalyticsInstancesSortByName           ListAnalyticsInstancesSortByEnum = "name"
	ListAnalyticsInstancesSortByTimecreated    ListAnalyticsInstancesSortByEnum = "timeCreated"
)

Set of constants representing the allowable values for ListAnalyticsInstancesSortByEnum

func GetListAnalyticsInstancesSortByEnumValues 

func GetListAnalyticsInstancesSortByEnumValues() []ListAnalyticsInstancesSortByEnum

GetListAnalyticsInstancesSortByEnumValues Enumerates the set of values for ListAnalyticsInstancesSortByEnum

func GetMappingListAnalyticsInstancesSortByEnum 

func GetMappingListAnalyticsInstancesSortByEnum(val string) (ListAnalyticsInstancesSortByEnum, bool)

GetMappingListAnalyticsInstancesSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListAnalyticsInstancesSortOrderEnum 

type ListAnalyticsInstancesSortOrderEnum string

ListAnalyticsInstancesSortOrderEnum Enum with underlying type: string 

const (
	ListAnalyticsInstancesSortOrderAsc  ListAnalyticsInstancesSortOrderEnum = "ASC"
	ListAnalyticsInstancesSortOrderDesc ListAnalyticsInstancesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListAnalyticsInstancesSortOrderEnum

func GetListAnalyticsInstancesSortOrderEnumValues 

func GetListAnalyticsInstancesSortOrderEnumValues() []ListAnalyticsInstancesSortOrderEnum

GetListAnalyticsInstancesSortOrderEnumValues Enumerates the set of values for ListAnalyticsInstancesSortOrderEnum

func GetMappingListAnalyticsInstancesSortOrderEnum 

func GetMappingListAnalyticsInstancesSortOrderEnum(val string) (ListAnalyticsInstancesSortOrderEnum, bool)

GetMappingListAnalyticsInstancesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestErrorsRequest 

type ListWorkRequestErrorsRequest struct {

	// The OCID of the work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// Unique identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// For list pagination. The maximum number of results per page, or items to return in a paginated
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// For list pagination. The value of the `opc-next-page` response header from the previous "List"
	// call. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.

func (ListWorkRequestErrorsRequest) BinaryRequestBody 

func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest 

func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy 

func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestErrorsRequest) String 

func (request ListWorkRequestErrorsRequest) String() string

func (ListWorkRequestErrorsRequest) ValidateEnumValue 

func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListWorkRequestErrorsResponse 

type ListWorkRequestErrorsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []WorkRequestError instances
	Items []WorkRequestError `presentIn:"body"`

	// For list pagination. When this header appears in the response, additional pages
	// of results remain. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse 

func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String 

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestLogsRequest 

type ListWorkRequestLogsRequest struct {

	// The OCID of the work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// Unique identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// For list pagination. The maximum number of results per page, or items to return in a paginated
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// For list pagination. The value of the `opc-next-page` response header from the previous "List"
	// call. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.

func (ListWorkRequestLogsRequest) BinaryRequestBody 

func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest 

func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy 

func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestLogsRequest) String 

func (request ListWorkRequestLogsRequest) String() string

func (ListWorkRequestLogsRequest) ValidateEnumValue 

func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListWorkRequestLogsResponse 

type ListWorkRequestLogsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []WorkRequestLog instances
	Items []WorkRequestLog `presentIn:"body"`

	// For list pagination. When this header appears in the response, additional pages
	// of results remain. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse 

func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String 

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestsRequest 

type ListWorkRequestsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The OCID of the resource associated with a work request.
	ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`

	// Type of the resource associated with a work request.
	ResourceType ListWorkRequestsResourceTypeEnum `mandatory:"false" contributesTo:"query" name:"resourceType" omitEmpty:"true"`

	// One or more work request status values to filter on.
	Status []WorkRequestStatusEnum `contributesTo:"query" name:"status" omitEmpty:"true" collectionFormat:"multi"`

	// For list pagination. The maximum number of results per page, or items to return in a paginated
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// For list pagination. The value of the `opc-next-page` response header from the previous "List"
	// call. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The field used for sorting work request results.
	SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// Unique identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.

func (ListWorkRequestsRequest) BinaryRequestBody 

func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest 

func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy 

func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestsRequest) String 

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue 

func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListWorkRequestsResourceTypeEnum 

type ListWorkRequestsResourceTypeEnum string

ListWorkRequestsResourceTypeEnum Enum with underlying type: string 

const (
	ListWorkRequestsResourceTypeAnalyticsInstance ListWorkRequestsResourceTypeEnum = "ANALYTICS_INSTANCE"
)

Set of constants representing the allowable values for ListWorkRequestsResourceTypeEnum

func GetListWorkRequestsResourceTypeEnumValues 

func GetListWorkRequestsResourceTypeEnumValues() []ListWorkRequestsResourceTypeEnum

GetListWorkRequestsResourceTypeEnumValues Enumerates the set of values for ListWorkRequestsResourceTypeEnum

func GetMappingListWorkRequestsResourceTypeEnum 

func GetMappingListWorkRequestsResourceTypeEnum(val string) (ListWorkRequestsResourceTypeEnum, bool)

GetMappingListWorkRequestsResourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestsResponse 

type ListWorkRequestsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []WorkRequestSummary instances
	Items []WorkRequestSummary `presentIn:"body"`

	// For list pagination. When this header appears in the response, additional pages
	// of results remain. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse 

func (response ListWorkRequestsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String 

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum 

type ListWorkRequestsSortByEnum string

ListWorkRequestsSortByEnum Enum with underlying type: string 

const (
	ListWorkRequestsSortById            ListWorkRequestsSortByEnum = "id"
	ListWorkRequestsSortByOperationtype ListWorkRequestsSortByEnum = "operationType"
	ListWorkRequestsSortByStatus        ListWorkRequestsSortByEnum = "status"
	ListWorkRequestsSortByTimeaccepted  ListWorkRequestsSortByEnum = "timeAccepted"
	ListWorkRequestsSortByTimestarted   ListWorkRequestsSortByEnum = "timeStarted"
	ListWorkRequestsSortByTimefinished  ListWorkRequestsSortByEnum = "timeFinished"
)

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortByEnumValues 

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum 

func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)

GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestsSortOrderEnum 

type ListWorkRequestsSortOrderEnum string

ListWorkRequestsSortOrderEnum Enum with underlying type: string 

const (
	ListWorkRequestsSortOrderAsc  ListWorkRequestsSortOrderEnum = "ASC"
	ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsSortOrderEnumValues 

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum 

func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)

GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type NetworkEndpointDetails 

type NetworkEndpointDetails interface {
}

NetworkEndpointDetails Base representation of a network endpoint.

type NetworkEndpointTypeEnum 

type NetworkEndpointTypeEnum string

NetworkEndpointTypeEnum Enum with underlying type: string 

const (
	NetworkEndpointTypePublic  NetworkEndpointTypeEnum = "PUBLIC"
	NetworkEndpointTypePrivate NetworkEndpointTypeEnum = "PRIVATE"
)

Set of constants representing the allowable values for NetworkEndpointTypeEnum

func GetMappingNetworkEndpointTypeEnum 

func GetMappingNetworkEndpointTypeEnum(val string) (NetworkEndpointTypeEnum, bool)

GetMappingNetworkEndpointTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetNetworkEndpointTypeEnumValues 

func GetNetworkEndpointTypeEnumValues() []NetworkEndpointTypeEnum

GetNetworkEndpointTypeEnumValues Enumerates the set of values for NetworkEndpointTypeEnum

type PrivateAccessChannel 

type PrivateAccessChannel struct {

	// Private Access Channel unique identifier key.
	Key *string `mandatory:"true" json:"key"`

	// Display Name of the Private Access Channel.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// OCID of the customer VCN peered with private access channel.
	VcnId *string `mandatory:"true" json:"vcnId"`

	// OCID of the customer subnet connected to private access channel.
	SubnetId *string `mandatory:"true" json:"subnetId"`

	// IP Address of the Private Access channel.
	IpAddress *string `mandatory:"true" json:"ipAddress"`

	// The list of IP addresses from the customer subnet connected to private access channel, used as a source Ip by Private Access Channel
	// for network traffic from the AnalyticsInstance to Private Sources.
	EgressSourceIpAddresses []string `mandatory:"true" json:"egressSourceIpAddresses"`

	// List of Private Source DNS zones registered with Private Access Channel,
	// where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance.
	// Min of 1 is required and Max of 30 Private Source DNS zones can be registered.
	PrivateSourceDnsZones []PrivateSourceDnsZone `mandatory:"false" json:"privateSourceDnsZones"`

	// List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.
	PrivateSourceScanHosts []PrivateSourceScanHost `mandatory:"false" json:"privateSourceScanHosts"`

	// Network Security Group OCIDs for an Analytics instance.
	NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`
}

PrivateAccessChannel Analytics Instance Private Access Channel model.

func (PrivateAccessChannel) String 

func (m PrivateAccessChannel) String() string

func (PrivateAccessChannel) ValidateEnumValue 

func (m PrivateAccessChannel) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type PrivateEndpointDetails 

type PrivateEndpointDetails struct {

	// The VCN OCID for the private endpoint.
	VcnId *string `mandatory:"true" json:"vcnId"`

	// The subnet OCID for the private endpoint.
	SubnetId *string `mandatory:"true" json:"subnetId"`

	// Network Security Group OCIDs for an Analytics instance.
	NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`
}

PrivateEndpointDetails Private endpoint configuration details.

func (PrivateEndpointDetails) MarshalJSON 

func (m PrivateEndpointDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (PrivateEndpointDetails) String 

func (m PrivateEndpointDetails) String() string

func (PrivateEndpointDetails) ValidateEnumValue 

func (m PrivateEndpointDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type PrivateSourceDnsZone 

type PrivateSourceDnsZone struct {

	// Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com.
	DnsZone *string `mandatory:"true" json:"dnsZone"`

	// Description of private source dns zone.
	Description *string `mandatory:"false" json:"description"`
}

PrivateSourceDnsZone Private source DNS Zone model.

func (PrivateSourceDnsZone) String 

func (m PrivateSourceDnsZone) String() string

func (PrivateSourceDnsZone) ValidateEnumValue 

func (m PrivateSourceDnsZone) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type PrivateSourceScanHost added in v65.18.1 

type PrivateSourceScanHost struct {

	// Private Source Scan hostname. Ex: db01-scan.corp.example.com, prd-db01-scan.mycompany.com.
	ScanHostname *string `mandatory:"true" json:"scanHostname"`

	// Private Source Scan host port. This is the source port where SCAN protocol will get connected (e.g. 1521).
	ScanPort *int `mandatory:"true" json:"scanPort"`

	// Description of private source scan host zone.
	Description *string `mandatory:"false" json:"description"`
}

PrivateSourceScanHost Private source Scan Hostname model.

func (PrivateSourceScanHost) String added in v65.18.1 

func (m PrivateSourceScanHost) String() string

func (PrivateSourceScanHost) ValidateEnumValue added in v65.18.1 

func (m PrivateSourceScanHost) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type PublicEndpointDetails 

type PublicEndpointDetails struct {

	// Source IP addresses or IP address ranges in ingress rules.
	WhitelistedIps []string `mandatory:"false" json:"whitelistedIps"`

	// Virtual Cloud Networks allowed to access this network endpoint.
	WhitelistedVcns []VirtualCloudNetwork `mandatory:"false" json:"whitelistedVcns"`

	// Oracle Cloud Services that are allowed to access this Analytics instance.
	WhitelistedServices []AccessControlServiceTypeEnum `mandatory:"false" json:"whitelistedServices,omitempty"`
}

PublicEndpointDetails Public endpoint configuration details.

func (PublicEndpointDetails) MarshalJSON 

func (m PublicEndpointDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (PublicEndpointDetails) String 

func (m PublicEndpointDetails) String() string

func (PublicEndpointDetails) ValidateEnumValue 

func (m PublicEndpointDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ScaleAnalyticsInstanceDetails 

type ScaleAnalyticsInstanceDetails struct {
	Capacity *Capacity `mandatory:"true" json:"capacity"`
}

ScaleAnalyticsInstanceDetails Input payload to scale an Analytics instance up or down.

func (ScaleAnalyticsInstanceDetails) String 

func (m ScaleAnalyticsInstanceDetails) String() string

func (ScaleAnalyticsInstanceDetails) ValidateEnumValue 

func (m ScaleAnalyticsInstanceDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ScaleAnalyticsInstanceRequest 

type ScaleAnalyticsInstanceRequest struct {

	// The OCID of the AnalyticsInstance.
	AnalyticsInstanceId *string `mandatory:"true" contributesTo:"path" name:"analyticsInstanceId"`

	// Input payload for scaling an Analytics instance up or down.
	ScaleAnalyticsInstanceDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ScaleAnalyticsInstanceRequest wrapper for the ScaleAnalyticsInstance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/ScaleAnalyticsInstance.go.html to see an example of how to use ScaleAnalyticsInstanceRequest.

func (ScaleAnalyticsInstanceRequest) BinaryRequestBody 

func (request ScaleAnalyticsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ScaleAnalyticsInstanceRequest) HTTPRequest 

func (request ScaleAnalyticsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ScaleAnalyticsInstanceRequest) RetryPolicy 

func (request ScaleAnalyticsInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ScaleAnalyticsInstanceRequest) String 

func (request ScaleAnalyticsInstanceRequest) String() string

func (ScaleAnalyticsInstanceRequest) ValidateEnumValue 

func (request ScaleAnalyticsInstanceRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ScaleAnalyticsInstanceResponse 

type ScaleAnalyticsInstanceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// The OCID of the work request. Use GetWorkRequest with this ID to track the status
	// of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

ScaleAnalyticsInstanceResponse wrapper for the ScaleAnalyticsInstance operation

func (ScaleAnalyticsInstanceResponse) HTTPResponse 

func (response ScaleAnalyticsInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ScaleAnalyticsInstanceResponse) String 

func (response ScaleAnalyticsInstanceResponse) String() string

type SetKmsKeyDetails 

type SetKmsKeyDetails struct {

	// OCID of the OCI Vault Key encrypting the customer data stored in this Analytics instance. An empty value indicates Oracle managed default encryption (null is not supported in this API).
	KmsKeyId *string `mandatory:"true" json:"kmsKeyId"`
}

SetKmsKeyDetails Input payload to reset the OCI Vault encryption key.

func (SetKmsKeyDetails) String 

func (m SetKmsKeyDetails) String() string

func (SetKmsKeyDetails) ValidateEnumValue 

func (m SetKmsKeyDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type SetKmsKeyRequest 

type SetKmsKeyRequest struct {

	// The OCID of the AnalyticsInstance.
	AnalyticsInstanceId *string `mandatory:"true" contributesTo:"path" name:"analyticsInstanceId"`

	// Input payload to reset the OCI Vault encryption key.
	SetKmsKeyDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

SetKmsKeyRequest wrapper for the SetKmsKey operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/SetKmsKey.go.html to see an example of how to use SetKmsKeyRequest.

func (SetKmsKeyRequest) BinaryRequestBody 

func (request SetKmsKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (SetKmsKeyRequest) HTTPRequest 

func (request SetKmsKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (SetKmsKeyRequest) RetryPolicy 

func (request SetKmsKeyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (SetKmsKeyRequest) String 

func (request SetKmsKeyRequest) String() string

func (SetKmsKeyRequest) ValidateEnumValue 

func (request SetKmsKeyRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type SetKmsKeyResponse 

type SetKmsKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// The OCID of the work request. Use GetWorkRequest with this ID to track the status
	// of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

SetKmsKeyResponse wrapper for the SetKmsKey operation

func (SetKmsKeyResponse) HTTPResponse 

func (response SetKmsKeyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (SetKmsKeyResponse) String 

func (response SetKmsKeyResponse) String() string

type SortByEnum 

type SortByEnum string

SortByEnum Enum with underlying type: string 

const (
	SortByCapacityType   SortByEnum = "capacityType"
	SortByCapacityValue  SortByEnum = "capacityValue"
	SortByFeatureSet     SortByEnum = "featureSet"
	SortByLifecycleState SortByEnum = "lifecycleState"
	SortByName           SortByEnum = "name"
	SortByTimeCreated    SortByEnum = "timeCreated"
)

Set of constants representing the allowable values for SortByEnum

func GetMappingSortByEnum 

func GetMappingSortByEnum(val string) (SortByEnum, bool)

GetMappingSortByEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSortByEnumValues 

func GetSortByEnumValues() []SortByEnum

GetSortByEnumValues Enumerates the set of values for SortByEnum

type SortOrderEnum 

type SortOrderEnum string

SortOrderEnum Enum with underlying type: string 

const (
	SortOrderAsc  SortOrderEnum = "ASC"
	SortOrderDesc SortOrderEnum = "DESC"
)

Set of constants representing the allowable values for SortOrderEnum

func GetMappingSortOrderEnum 

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSortOrderEnumValues 

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type StartAnalyticsInstanceRequest 

type StartAnalyticsInstanceRequest struct {

	// The OCID of the AnalyticsInstance.
	AnalyticsInstanceId *string `mandatory:"true" contributesTo:"path" name:"analyticsInstanceId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

StartAnalyticsInstanceRequest wrapper for the StartAnalyticsInstance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/StartAnalyticsInstance.go.html to see an example of how to use StartAnalyticsInstanceRequest.

func (StartAnalyticsInstanceRequest) BinaryRequestBody 

func (request StartAnalyticsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (StartAnalyticsInstanceRequest) HTTPRequest 

func (request StartAnalyticsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (StartAnalyticsInstanceRequest) RetryPolicy 

func (request StartAnalyticsInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (StartAnalyticsInstanceRequest) String 

func (request StartAnalyticsInstanceRequest) String() string

func (StartAnalyticsInstanceRequest) ValidateEnumValue 

func (request StartAnalyticsInstanceRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type StartAnalyticsInstanceResponse 

type StartAnalyticsInstanceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// The OCID of the work request. Use GetWorkRequest with this ID to track the status
	// of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

StartAnalyticsInstanceResponse wrapper for the StartAnalyticsInstance operation

func (StartAnalyticsInstanceResponse) HTTPResponse 

func (response StartAnalyticsInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (StartAnalyticsInstanceResponse) String 

func (response StartAnalyticsInstanceResponse) String() string

type StopAnalyticsInstanceRequest 

type StopAnalyticsInstanceRequest struct {

	// The OCID of the AnalyticsInstance.
	AnalyticsInstanceId *string `mandatory:"true" contributesTo:"path" name:"analyticsInstanceId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

StopAnalyticsInstanceRequest wrapper for the StopAnalyticsInstance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/StopAnalyticsInstance.go.html to see an example of how to use StopAnalyticsInstanceRequest.

func (StopAnalyticsInstanceRequest) BinaryRequestBody 

func (request StopAnalyticsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (StopAnalyticsInstanceRequest) HTTPRequest 

func (request StopAnalyticsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (StopAnalyticsInstanceRequest) RetryPolicy 

func (request StopAnalyticsInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (StopAnalyticsInstanceRequest) String 

func (request StopAnalyticsInstanceRequest) String() string

func (StopAnalyticsInstanceRequest) ValidateEnumValue 

func (request StopAnalyticsInstanceRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type StopAnalyticsInstanceResponse 

type StopAnalyticsInstanceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// The OCID of the work request. Use GetWorkRequest with this ID to track the status
	// of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

StopAnalyticsInstanceResponse wrapper for the StopAnalyticsInstance operation

func (StopAnalyticsInstanceResponse) HTTPResponse 

func (response StopAnalyticsInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (StopAnalyticsInstanceResponse) String 

func (response StopAnalyticsInstanceResponse) String() string

type UpdateAnalyticsInstanceDetails 

type UpdateAnalyticsInstanceDetails struct {

	// Optional description.
	Description *string `mandatory:"false" json:"description"`

	// Email address receiving notifications.
	EmailNotification *string `mandatory:"false" json:"emailNotification"`

	// The license used for the service.
	LicenseType LicenseTypeEnum `mandatory:"false" json:"licenseType,omitempty"`

	// Defined tags for this resource. Each key is predefined and scoped to a
	// namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

UpdateAnalyticsInstanceDetails Input payload to update an Analytics instance. Fields that are not provided will not be updated.

func (UpdateAnalyticsInstanceDetails) String 

func (m UpdateAnalyticsInstanceDetails) String() string

func (UpdateAnalyticsInstanceDetails) ValidateEnumValue 

func (m UpdateAnalyticsInstanceDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateAnalyticsInstanceRequest 

type UpdateAnalyticsInstanceRequest struct {

	// The OCID of the AnalyticsInstance.
	AnalyticsInstanceId *string `mandatory:"true" contributesTo:"path" name:"analyticsInstanceId"`

	// The Analytics Instance fields to update. Fields that are not provided
	// will not be updated.
	UpdateAnalyticsInstanceDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

UpdateAnalyticsInstanceRequest wrapper for the UpdateAnalyticsInstance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/UpdateAnalyticsInstance.go.html to see an example of how to use UpdateAnalyticsInstanceRequest.

func (UpdateAnalyticsInstanceRequest) BinaryRequestBody 

func (request UpdateAnalyticsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateAnalyticsInstanceRequest) HTTPRequest 

func (request UpdateAnalyticsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateAnalyticsInstanceRequest) RetryPolicy 

func (request UpdateAnalyticsInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateAnalyticsInstanceRequest) String 

func (request UpdateAnalyticsInstanceRequest) String() string

func (UpdateAnalyticsInstanceRequest) ValidateEnumValue 

func (request UpdateAnalyticsInstanceRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateAnalyticsInstanceResponse 

type UpdateAnalyticsInstanceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The AnalyticsInstance instance
	AnalyticsInstance `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

UpdateAnalyticsInstanceResponse wrapper for the UpdateAnalyticsInstance operation

func (UpdateAnalyticsInstanceResponse) HTTPResponse 

func (response UpdateAnalyticsInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateAnalyticsInstanceResponse) String 

func (response UpdateAnalyticsInstanceResponse) String() string

type UpdatePrivateAccessChannelDetails 

type UpdatePrivateAccessChannelDetails struct {

	// Display Name of the Private Access Channel.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// OCID of the customer VCN peered with private access channel.
	VcnId *string `mandatory:"false" json:"vcnId"`

	// OCID of the customer subnet connected to private access channel.
	SubnetId *string `mandatory:"false" json:"subnetId"`

	// List of Private Source DNS zones registered with Private Access Channel,
	// where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance.
	// Min of 1 is required and Max of 30 Private Source DNS zones can be registered.
	PrivateSourceDnsZones []PrivateSourceDnsZone `mandatory:"false" json:"privateSourceDnsZones"`

	// List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance.
	PrivateSourceScanHosts []PrivateSourceScanHost `mandatory:"false" json:"privateSourceScanHosts"`

	// Network Security Group OCIDs for an Analytics instance.
	NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`
}

UpdatePrivateAccessChannelDetails Input payload to update a Private Access Channel.

func (UpdatePrivateAccessChannelDetails) String 

func (m UpdatePrivateAccessChannelDetails) String() string

func (UpdatePrivateAccessChannelDetails) ValidateEnumValue 

func (m UpdatePrivateAccessChannelDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdatePrivateAccessChannelRequest 

type UpdatePrivateAccessChannelRequest struct {

	// The unique identifier key of the Private Access Channel.
	PrivateAccessChannelKey *string `mandatory:"true" contributesTo:"path" name:"privateAccessChannelKey"`

	// The OCID of the AnalyticsInstance.
	AnalyticsInstanceId *string `mandatory:"true" contributesTo:"path" name:"analyticsInstanceId"`

	// Update the Private Access Channel with the given unique identifier key in the specified Analytics Instance.
	UpdatePrivateAccessChannelDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

UpdatePrivateAccessChannelRequest wrapper for the UpdatePrivateAccessChannel operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/UpdatePrivateAccessChannel.go.html to see an example of how to use UpdatePrivateAccessChannelRequest.

func (UpdatePrivateAccessChannelRequest) BinaryRequestBody 

func (request UpdatePrivateAccessChannelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdatePrivateAccessChannelRequest) HTTPRequest 

func (request UpdatePrivateAccessChannelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdatePrivateAccessChannelRequest) RetryPolicy 

func (request UpdatePrivateAccessChannelRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdatePrivateAccessChannelRequest) String 

func (request UpdatePrivateAccessChannelRequest) String() string

func (UpdatePrivateAccessChannelRequest) ValidateEnumValue 

func (request UpdatePrivateAccessChannelRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdatePrivateAccessChannelResponse 

type UpdatePrivateAccessChannelResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// The OCID of the work request. Use GetWorkRequest with this ID to track the status
	// of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

UpdatePrivateAccessChannelResponse wrapper for the UpdatePrivateAccessChannel operation

func (UpdatePrivateAccessChannelResponse) HTTPResponse 

func (response UpdatePrivateAccessChannelResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdatePrivateAccessChannelResponse) String 

func (response UpdatePrivateAccessChannelResponse) String() string

type UpdateVanityUrlDetails 

type UpdateVanityUrlDetails struct {

	// PEM Private key for HTTPS connections.
	PrivateKey *string `mandatory:"true" json:"privateKey"`

	// PEM certificate for HTTPS connections.
	PublicCertificate *string `mandatory:"true" json:"publicCertificate"`

	// PEM CA certificate(s) for HTTPS connections. This may include multiple PEM certificates.
	CaCertificate *string `mandatory:"true" json:"caCertificate"`

	// Passphrase for the PEM Private key (if any).
	Passphrase *string `mandatory:"false" json:"passphrase"`
}

UpdateVanityUrlDetails Input payload to update a vanity url.

func (UpdateVanityUrlDetails) String 

func (m UpdateVanityUrlDetails) String() string

func (UpdateVanityUrlDetails) ValidateEnumValue 

func (m UpdateVanityUrlDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateVanityUrlRequest 

type UpdateVanityUrlRequest struct {

	// The OCID of the AnalyticsInstance.
	AnalyticsInstanceId *string `mandatory:"true" contributesTo:"path" name:"analyticsInstanceId"`

	// Specify unique identifier key of a vanity url to update or delete.
	VanityUrlKey *string `mandatory:"true" contributesTo:"path" name:"vanityUrlKey"`

	// Vanity url details to update (certificate).
	UpdateVanityUrlDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

UpdateVanityUrlRequest wrapper for the UpdateVanityUrl operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/analytics/UpdateVanityUrl.go.html to see an example of how to use UpdateVanityUrlRequest.

func (UpdateVanityUrlRequest) BinaryRequestBody 

func (request UpdateVanityUrlRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateVanityUrlRequest) HTTPRequest 

func (request UpdateVanityUrlRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateVanityUrlRequest) RetryPolicy 

func (request UpdateVanityUrlRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateVanityUrlRequest) String 

func (request UpdateVanityUrlRequest) String() string

func (UpdateVanityUrlRequest) ValidateEnumValue 

func (request UpdateVanityUrlRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateVanityUrlResponse 

type UpdateVanityUrlResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// The OCID of the work request. Use GetWorkRequest with this ID to track the status
	// of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

UpdateVanityUrlResponse wrapper for the UpdateVanityUrl operation

func (UpdateVanityUrlResponse) HTTPResponse 

func (response UpdateVanityUrlResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateVanityUrlResponse) String 

func (response UpdateVanityUrlResponse) String() string

type VanityUrlDetails 

type VanityUrlDetails struct {

	// The vanity url unique identifier key.
	Key *string `mandatory:"false" json:"key"`

	// Description of the vanity url.
	Description *string `mandatory:"false" json:"description"`

	// List of urls supported by this vanity URL definition (max of 3).
	Urls []string `mandatory:"false" json:"urls"`

	// List of fully qualified hostnames supported by this vanity URL definition (max of 3).
	Hosts []string `mandatory:"false" json:"hosts"`

	// PEM certificate for HTTPS connections.
	PublicCertificate *string `mandatory:"false" json:"publicCertificate"`
}

VanityUrlDetails Vanity url configuration details.

func (VanityUrlDetails) String 

func (m VanityUrlDetails) String() string

func (VanityUrlDetails) ValidateEnumValue 

func (m VanityUrlDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type VirtualCloudNetwork 

type VirtualCloudNetwork struct {

	// The Virtual Cloud Network OCID.
	Id *string `mandatory:"true" json:"id"`

	// Source IP addresses or IP address ranges in ingress rules.
	WhitelistedIps []string `mandatory:"false" json:"whitelistedIps"`
}

VirtualCloudNetwork Virtual Cloud Network definition.

func (VirtualCloudNetwork) String 

func (m VirtualCloudNetwork) String() string

func (VirtualCloudNetwork) ValidateEnumValue 

func (m VirtualCloudNetwork) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequest 

type WorkRequest struct {

	// The resource OCID.
	Id *string `mandatory:"true" json:"id"`

	// The operation performed by the work request.
	OperationType WorkRequestOperationTypeEnum `mandatory:"true" json:"operationType"`

	// The current status of the work request.
	Status WorkRequestStatusEnum `mandatory:"true" json:"status"`

	// The compartment OCID of this work request.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The resources this work request affects.
	Resources []WorkRequestResource `mandatory:"true" json:"resources"`

	// Percentage of the request completed.
	PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

	// The time the work request was accepted, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

	// The time the work request was started, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// The time the work request was finished, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}

WorkRequest An asynchronous work request.

func (WorkRequest) String 

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue 

func (m WorkRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestActionResultEnum 

type WorkRequestActionResultEnum string

WorkRequestActionResultEnum Enum with underlying type: string 

const (
	WorkRequestActionResultCompartmentChanged          WorkRequestActionResultEnum = "COMPARTMENT_CHANGED"
	WorkRequestActionResultCreated                     WorkRequestActionResultEnum = "CREATED"
	WorkRequestActionResultDeleted                     WorkRequestActionResultEnum = "DELETED"
	WorkRequestActionResultStarted                     WorkRequestActionResultEnum = "STARTED"
	WorkRequestActionResultStopped                     WorkRequestActionResultEnum = "STOPPED"
	WorkRequestActionResultScaled                      WorkRequestActionResultEnum = "SCALED"
	WorkRequestActionResultNetworkEndpointChanged      WorkRequestActionResultEnum = "NETWORK_ENDPOINT_CHANGED"
	WorkRequestActionResultVanityUrlCreated            WorkRequestActionResultEnum = "VANITY_URL_CREATED"
	WorkRequestActionResultVanityUrlUpdated            WorkRequestActionResultEnum = "VANITY_URL_UPDATED"
	WorkRequestActionResultVanityUrlDeleted            WorkRequestActionResultEnum = "VANITY_URL_DELETED"
	WorkRequestActionResultPrivateAccessChannelCreated WorkRequestActionResultEnum = "PRIVATE_ACCESS_CHANNEL_CREATED"
	WorkRequestActionResultPrivateAccessChannelUpdated WorkRequestActionResultEnum = "PRIVATE_ACCESS_CHANNEL_UPDATED"
	WorkRequestActionResultPrivateAccessChannelDeleted WorkRequestActionResultEnum = "PRIVATE_ACCESS_CHANNEL_DELETED"
	WorkRequestActionResultNone                        WorkRequestActionResultEnum = "NONE"
)

Set of constants representing the allowable values for WorkRequestActionResultEnum

func GetMappingWorkRequestActionResultEnum 

func GetMappingWorkRequestActionResultEnum(val string) (WorkRequestActionResultEnum, bool)

GetMappingWorkRequestActionResultEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestActionResultEnumValues 

func GetWorkRequestActionResultEnumValues() []WorkRequestActionResultEnum

GetWorkRequestActionResultEnumValues Enumerates the set of values for WorkRequestActionResultEnum

type WorkRequestError 

type WorkRequestError struct {

	// A short error code that defines the error, meant for programmatic parsing.
	Code *string `mandatory:"true" json:"code"`

	// Error message.
	Message *string `mandatory:"true" json:"message"`

	// The date and time the error occured, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

WorkRequestError Error encountered during the execution of a work request.

func (WorkRequestError) String 

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue 

func (m WorkRequestError) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestLog 

type WorkRequestLog struct {

	// The description of the event that occurred.
	Message *string `mandatory:"true" json:"message"`

	// The date and time the log entry occured, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

WorkRequestLog Log entries related to a specific work request.

func (WorkRequestLog) String 

func (m WorkRequestLog) String() string

func (WorkRequestLog) ValidateEnumValue 

func (m WorkRequestLog) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestOperationTypeEnum 

type WorkRequestOperationTypeEnum string

WorkRequestOperationTypeEnum Enum with underlying type: string 

const (
	WorkRequestOperationTypeCreateAnalyticsInstance                WorkRequestOperationTypeEnum = "CREATE_ANALYTICS_INSTANCE"
	WorkRequestOperationTypeDeleteAnalyticsInstance                WorkRequestOperationTypeEnum = "DELETE_ANALYTICS_INSTANCE"
	WorkRequestOperationTypeStartAnalyticsInstance                 WorkRequestOperationTypeEnum = "START_ANALYTICS_INSTANCE"
	WorkRequestOperationTypeStopAnalyticsInstance                  WorkRequestOperationTypeEnum = "STOP_ANALYTICS_INSTANCE"
	WorkRequestOperationTypeScaleAnalyticsInstance                 WorkRequestOperationTypeEnum = "SCALE_ANALYTICS_INSTANCE"
	WorkRequestOperationTypeChangeAnalyticsInstanceCompartment     WorkRequestOperationTypeEnum = "CHANGE_ANALYTICS_INSTANCE_COMPARTMENT"
	WorkRequestOperationTypeChangeAnalyticsInstanceNetworkEndpoint WorkRequestOperationTypeEnum = "CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT"
	WorkRequestOperationTypeCreateVanityUrl                        WorkRequestOperationTypeEnum = "CREATE_VANITY_URL"
	WorkRequestOperationTypeUpdateVanityUrl                        WorkRequestOperationTypeEnum = "UPDATE_VANITY_URL"
	WorkRequestOperationTypeDeleteVanityUrl                        WorkRequestOperationTypeEnum = "DELETE_VANITY_URL"
	WorkRequestOperationTypeCreatePrivateAccessChannel             WorkRequestOperationTypeEnum = "CREATE_PRIVATE_ACCESS_CHANNEL"
	WorkRequestOperationTypeUpdatePrivateAccessChannel             WorkRequestOperationTypeEnum = "UPDATE_PRIVATE_ACCESS_CHANNEL"
	WorkRequestOperationTypeDeletePrivateAccessChannel             WorkRequestOperationTypeEnum = "DELETE_PRIVATE_ACCESS_CHANNEL"
	WorkRequestOperationTypeUpdateInstanceEncryptionKey            WorkRequestOperationTypeEnum = "UPDATE_INSTANCE_ENCRYPTION_KEY"
)

Set of constants representing the allowable values for WorkRequestOperationTypeEnum

func GetMappingWorkRequestOperationTypeEnum 

func GetMappingWorkRequestOperationTypeEnum(val string) (WorkRequestOperationTypeEnum, bool)

GetMappingWorkRequestOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestOperationTypeEnumValues 

func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum

GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum

type WorkRequestResource 

type WorkRequestResource struct {

	// The way in which this resource was affected by this work request.
	ActionResult WorkRequestActionResultEnum `mandatory:"true" json:"actionResult"`

	// The type of the resource the work request is affecting.
	ResourceType WorkRequestResourceTypeEnum `mandatory:"true" json:"resourceType"`

	// The OCID of the resource the work request is affecting.
	Identifier *string `mandatory:"true" json:"identifier"`

	// The URI of the affected resource.
	ResourceUri *string `mandatory:"true" json:"resourceUri"`

	// Additional metadata of the resource.
	Metadata map[string]string `mandatory:"false" json:"metadata"`
}

WorkRequestResource The representation of WorkRequestResource

func (WorkRequestResource) String 

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue 

func (m WorkRequestResource) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestResourceTypeEnum 

type WorkRequestResourceTypeEnum string

WorkRequestResourceTypeEnum Enum with underlying type: string 

const (
	WorkRequestResourceTypeAnalyticsInstance WorkRequestResourceTypeEnum = "ANALYTICS_INSTANCE"
)

Set of constants representing the allowable values for WorkRequestResourceTypeEnum

func GetMappingWorkRequestResourceTypeEnum 

func GetMappingWorkRequestResourceTypeEnum(val string) (WorkRequestResourceTypeEnum, bool)

GetMappingWorkRequestResourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestResourceTypeEnumValues 

func GetWorkRequestResourceTypeEnumValues() []WorkRequestResourceTypeEnum

GetWorkRequestResourceTypeEnumValues Enumerates the set of values for WorkRequestResourceTypeEnum

type WorkRequestSortByEnum 

type WorkRequestSortByEnum string

WorkRequestSortByEnum Enum with underlying type: string 

const (
	WorkRequestSortById            WorkRequestSortByEnum = "id"
	WorkRequestSortByOperationType WorkRequestSortByEnum = "operationType"
	WorkRequestSortByStatus        WorkRequestSortByEnum = "status"
	WorkRequestSortByTimeAccepted  WorkRequestSortByEnum = "timeAccepted"
	WorkRequestSortByTimeStarted   WorkRequestSortByEnum = "timeStarted"
	WorkRequestSortByTimeFinished  WorkRequestSortByEnum = "timeFinished"
)

Set of constants representing the allowable values for WorkRequestSortByEnum

func GetMappingWorkRequestSortByEnum 

func GetMappingWorkRequestSortByEnum(val string) (WorkRequestSortByEnum, bool)

GetMappingWorkRequestSortByEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestSortByEnumValues 

func GetWorkRequestSortByEnumValues() []WorkRequestSortByEnum

GetWorkRequestSortByEnumValues Enumerates the set of values for WorkRequestSortByEnum

type WorkRequestStatusEnum 

type WorkRequestStatusEnum string

WorkRequestStatusEnum Enum with underlying type: string 

const (
	WorkRequestStatusAccepted   WorkRequestStatusEnum = "ACCEPTED"
	WorkRequestStatusInProgress WorkRequestStatusEnum = "IN_PROGRESS"
	WorkRequestStatusFailed     WorkRequestStatusEnum = "FAILED"
	WorkRequestStatusSucceeded  WorkRequestStatusEnum = "SUCCEEDED"
	WorkRequestStatusCanceling  WorkRequestStatusEnum = "CANCELING"
	WorkRequestStatusCanceled   WorkRequestStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for WorkRequestStatusEnum

func GetMappingWorkRequestStatusEnum 

func GetMappingWorkRequestStatusEnum(val string) (WorkRequestStatusEnum, bool)

GetMappingWorkRequestStatusEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestStatusEnumValues 

func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum

GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum

type WorkRequestSummary 

type WorkRequestSummary struct {

	// The resource OCID.
	Id *string `mandatory:"true" json:"id"`

	// The operation performed by the work request.
	OperationType WorkRequestOperationTypeEnum `mandatory:"true" json:"operationType"`

	// The current status of the work request.
	Status WorkRequestStatusEnum `mandatory:"true" json:"status"`

	// The compartment OCID of this work request.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The resources this work request affects.
	Resources []WorkRequestResource `mandatory:"true" json:"resources"`

	// The time the work request was accepted, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

	// The time the work request was started, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// The time the work request was finished, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}

WorkRequestSummary An asynchronous work request.

func (WorkRequestSummary) String 

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue 

func (m WorkRequestSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

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.