AnalyticsClient a client for Analytics
type AnalyticsClient struct { common.BaseClient // contains filtered or unexported fields }
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(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 (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.
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.
func (client *AnalyticsClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
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.
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.
func (client AnalyticsClient) DeleteWorkRequest(ctx context.Context, request DeleteWorkRequestRequest) (response DeleteWorkRequestResponse, err error)
DeleteWorkRequest Cancel a work request that has not started yet.
func (client AnalyticsClient) GetAnalyticsInstance(ctx context.Context, request GetAnalyticsInstanceRequest) (response GetAnalyticsInstanceResponse, err error)
GetAnalyticsInstance Info for a specific Analytics instance.
func (client AnalyticsClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Get the details of a work request.
func (client AnalyticsClient) ListAnalyticsInstances(ctx context.Context, request ListAnalyticsInstancesRequest) (response ListAnalyticsInstancesResponse, err error)
ListAnalyticsInstances List Analytics instances.
func (client AnalyticsClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Get the errors of a work request.
func (client AnalyticsClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Get the logs of a work request.
func (client AnalyticsClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests List all work requests in a compartment.
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.
func (client *AnalyticsClient) SetRegion(region string)
SetRegion overrides the region of this client.
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.
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.
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.
AnalyticsInstance Analytics Instance metadata.
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"` // 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 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"` }
func (m AnalyticsInstance) String() string
func (m *AnalyticsInstance) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
AnalyticsInstanceLifecycleStateEnum Enum with underlying type: string
type AnalyticsInstanceLifecycleStateEnum string
Set of constants representing the allowable values for AnalyticsInstanceLifecycleStateEnum
const ( AnalyticsInstanceLifecycleStateActive AnalyticsInstanceLifecycleStateEnum = "ACTIVE" AnalyticsInstanceLifecycleStateCreating AnalyticsInstanceLifecycleStateEnum = "CREATING" AnalyticsInstanceLifecycleStateDeleted AnalyticsInstanceLifecycleStateEnum = "DELETED" AnalyticsInstanceLifecycleStateDeleting AnalyticsInstanceLifecycleStateEnum = "DELETING" AnalyticsInstanceLifecycleStateFailed AnalyticsInstanceLifecycleStateEnum = "FAILED" AnalyticsInstanceLifecycleStateInactive AnalyticsInstanceLifecycleStateEnum = "INACTIVE" AnalyticsInstanceLifecycleStateUpdating AnalyticsInstanceLifecycleStateEnum = "UPDATING" )
func GetAnalyticsInstanceLifecycleStateEnumValues() []AnalyticsInstanceLifecycleStateEnum
GetAnalyticsInstanceLifecycleStateEnumValues Enumerates the set of values for AnalyticsInstanceLifecycleStateEnum
AnalyticsInstanceSummary Analytics Instance metadata (summary view).
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"` }
func (m AnalyticsInstanceSummary) String() string
func (m *AnalyticsInstanceSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
Capacity Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).
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"` }
func (m Capacity) String() string
CapacityTypeEnum Enum with underlying type: string
type CapacityTypeEnum string
Set of constants representing the allowable values for CapacityTypeEnum
const ( CapacityTypeOlpuCount CapacityTypeEnum = "OLPU_COUNT" CapacityTypeUserCount CapacityTypeEnum = "USER_COUNT" )
func GetCapacityTypeEnumValues() []CapacityTypeEnum
GetCapacityTypeEnumValues Enumerates the set of values for CapacityTypeEnum
ChangeAnalyticsInstanceCompartmentRequest wrapper for the ChangeAnalyticsInstanceCompartment operation
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 }
func (request ChangeAnalyticsInstanceCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeAnalyticsInstanceCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeAnalyticsInstanceCompartmentRequest) String() string
ChangeAnalyticsInstanceCompartmentResponse wrapper for the ChangeAnalyticsInstanceCompartment operation
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"` }
func (response ChangeAnalyticsInstanceCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeAnalyticsInstanceCompartmentResponse) String() string
ChangeAnalyticsInstanceNetworkEndpointDetails Input payload to update an Analytics instance endpoint details.
type ChangeAnalyticsInstanceNetworkEndpointDetails struct { NetworkEndpointDetails NetworkEndpointDetails `mandatory:"true" json:"networkEndpointDetails"` }
func (m ChangeAnalyticsInstanceNetworkEndpointDetails) String() string
func (m *ChangeAnalyticsInstanceNetworkEndpointDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
ChangeAnalyticsInstanceNetworkEndpointRequest wrapper for the ChangeAnalyticsInstanceNetworkEndpoint operation
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 }
func (request ChangeAnalyticsInstanceNetworkEndpointRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeAnalyticsInstanceNetworkEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeAnalyticsInstanceNetworkEndpointRequest) String() string
ChangeAnalyticsInstanceNetworkEndpointResponse wrapper for the ChangeAnalyticsInstanceNetworkEndpoint operation
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"` }
func (response ChangeAnalyticsInstanceNetworkEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeAnalyticsInstanceNetworkEndpointResponse) String() string
ChangeCompartmentDetails Input payload to change a resource's compartment.
type ChangeCompartmentDetails struct { // The OCID of the new compartment. CompartmentId *string `mandatory:"true" json:"compartmentId"` }
func (m ChangeCompartmentDetails) String() string
CreateAnalyticsInstanceDetails Input payload to create an Anaytics instance.
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"` }
func (m CreateAnalyticsInstanceDetails) String() string
func (m *CreateAnalyticsInstanceDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
CreateAnalyticsInstanceRequest wrapper for the CreateAnalyticsInstance operation
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 }
func (request CreateAnalyticsInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateAnalyticsInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateAnalyticsInstanceRequest) String() string
CreateAnalyticsInstanceResponse wrapper for the CreateAnalyticsInstance operation
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"` }
func (response CreateAnalyticsInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateAnalyticsInstanceResponse) String() string
DeleteAnalyticsInstanceRequest wrapper for the DeleteAnalyticsInstance operation
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 }
func (request DeleteAnalyticsInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteAnalyticsInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteAnalyticsInstanceRequest) String() string
DeleteAnalyticsInstanceResponse wrapper for the DeleteAnalyticsInstance operation
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"` }
func (response DeleteAnalyticsInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteAnalyticsInstanceResponse) String() string
DeleteWorkRequestRequest wrapper for the DeleteWorkRequest operation
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 }
func (request DeleteWorkRequestRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteWorkRequestRequest) String() string
DeleteWorkRequestResponse wrapper for the DeleteWorkRequest operation
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"` }
func (response DeleteWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteWorkRequestResponse) String() string
FeatureSetEnum Enum with underlying type: string
type FeatureSetEnum string
Set of constants representing the allowable values for FeatureSetEnum
const ( FeatureSetSelfServiceAnalytics FeatureSetEnum = "SELF_SERVICE_ANALYTICS" FeatureSetEnterpriseAnalytics FeatureSetEnum = "ENTERPRISE_ANALYTICS" )
func GetFeatureSetEnumValues() []FeatureSetEnum
GetFeatureSetEnumValues Enumerates the set of values for FeatureSetEnum
GetAnalyticsInstanceRequest wrapper for the GetAnalyticsInstance operation
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 }
func (request GetAnalyticsInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAnalyticsInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAnalyticsInstanceRequest) String() string
GetAnalyticsInstanceResponse wrapper for the GetAnalyticsInstance operation
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"` }
func (response GetAnalyticsInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAnalyticsInstanceResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
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 }
func (request GetWorkRequestRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
GetWorkRequestResponse wrapper for the GetWorkRequest operation
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"` }
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
LicenseTypeEnum Enum with underlying type: string
type LicenseTypeEnum string
Set of constants representing the allowable values for LicenseTypeEnum
const ( LicenseTypeLicenseIncluded LicenseTypeEnum = "LICENSE_INCLUDED" LicenseTypeBringYourOwnLicense LicenseTypeEnum = "BRING_YOUR_OWN_LICENSE" )
func GetLicenseTypeEnumValues() []LicenseTypeEnum
GetLicenseTypeEnumValues Enumerates the set of values for LicenseTypeEnum
ListAnalyticsInstancesCapacityTypeEnum Enum with underlying type: string
type ListAnalyticsInstancesCapacityTypeEnum string
Set of constants representing the allowable values for ListAnalyticsInstancesCapacityTypeEnum
const ( ListAnalyticsInstancesCapacityTypeOlpuCount ListAnalyticsInstancesCapacityTypeEnum = "OLPU_COUNT" ListAnalyticsInstancesCapacityTypeUserCount ListAnalyticsInstancesCapacityTypeEnum = "USER_COUNT" )
func GetListAnalyticsInstancesCapacityTypeEnumValues() []ListAnalyticsInstancesCapacityTypeEnum
GetListAnalyticsInstancesCapacityTypeEnumValues Enumerates the set of values for ListAnalyticsInstancesCapacityTypeEnum
ListAnalyticsInstancesFeatureSetEnum Enum with underlying type: string
type ListAnalyticsInstancesFeatureSetEnum string
Set of constants representing the allowable values for ListAnalyticsInstancesFeatureSetEnum
const ( ListAnalyticsInstancesFeatureSetSelfServiceAnalytics ListAnalyticsInstancesFeatureSetEnum = "SELF_SERVICE_ANALYTICS" ListAnalyticsInstancesFeatureSetEnterpriseAnalytics ListAnalyticsInstancesFeatureSetEnum = "ENTERPRISE_ANALYTICS" )
func GetListAnalyticsInstancesFeatureSetEnumValues() []ListAnalyticsInstancesFeatureSetEnum
GetListAnalyticsInstancesFeatureSetEnumValues Enumerates the set of values for ListAnalyticsInstancesFeatureSetEnum
ListAnalyticsInstancesLifecycleStateEnum Enum with underlying type: string
type ListAnalyticsInstancesLifecycleStateEnum string
Set of constants representing the allowable values for ListAnalyticsInstancesLifecycleStateEnum
const ( ListAnalyticsInstancesLifecycleStateActive ListAnalyticsInstancesLifecycleStateEnum = "ACTIVE" ListAnalyticsInstancesLifecycleStateCreating ListAnalyticsInstancesLifecycleStateEnum = "CREATING" ListAnalyticsInstancesLifecycleStateDeleted ListAnalyticsInstancesLifecycleStateEnum = "DELETED" ListAnalyticsInstancesLifecycleStateDeleting ListAnalyticsInstancesLifecycleStateEnum = "DELETING" ListAnalyticsInstancesLifecycleStateFailed ListAnalyticsInstancesLifecycleStateEnum = "FAILED" ListAnalyticsInstancesLifecycleStateInactive ListAnalyticsInstancesLifecycleStateEnum = "INACTIVE" ListAnalyticsInstancesLifecycleStateUpdating ListAnalyticsInstancesLifecycleStateEnum = "UPDATING" )
func GetListAnalyticsInstancesLifecycleStateEnumValues() []ListAnalyticsInstancesLifecycleStateEnum
GetListAnalyticsInstancesLifecycleStateEnumValues Enumerates the set of values for ListAnalyticsInstancesLifecycleStateEnum
ListAnalyticsInstancesRequest wrapper for the ListAnalyticsInstances operation
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 }
func (request ListAnalyticsInstancesRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAnalyticsInstancesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAnalyticsInstancesRequest) String() string
ListAnalyticsInstancesResponse wrapper for the ListAnalyticsInstances operation
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"` }
func (response ListAnalyticsInstancesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAnalyticsInstancesResponse) String() string
ListAnalyticsInstancesSortByEnum Enum with underlying type: string
type ListAnalyticsInstancesSortByEnum string
Set of constants representing the allowable values for ListAnalyticsInstancesSortByEnum
const ( ListAnalyticsInstancesSortByCapacitytype ListAnalyticsInstancesSortByEnum = "capacityType" ListAnalyticsInstancesSortByCapacityvalue ListAnalyticsInstancesSortByEnum = "capacityValue" ListAnalyticsInstancesSortByFeatureset ListAnalyticsInstancesSortByEnum = "featureSet" ListAnalyticsInstancesSortByLifecyclestate ListAnalyticsInstancesSortByEnum = "lifecycleState" ListAnalyticsInstancesSortByName ListAnalyticsInstancesSortByEnum = "name" ListAnalyticsInstancesSortByTimecreated ListAnalyticsInstancesSortByEnum = "timeCreated" )
func GetListAnalyticsInstancesSortByEnumValues() []ListAnalyticsInstancesSortByEnum
GetListAnalyticsInstancesSortByEnumValues Enumerates the set of values for ListAnalyticsInstancesSortByEnum
ListAnalyticsInstancesSortOrderEnum Enum with underlying type: string
type ListAnalyticsInstancesSortOrderEnum string
Set of constants representing the allowable values for ListAnalyticsInstancesSortOrderEnum
const ( ListAnalyticsInstancesSortOrderAsc ListAnalyticsInstancesSortOrderEnum = "ASC" ListAnalyticsInstancesSortOrderDesc ListAnalyticsInstancesSortOrderEnum = "DESC" )
func GetListAnalyticsInstancesSortOrderEnumValues() []ListAnalyticsInstancesSortOrderEnum
GetListAnalyticsInstancesSortOrderEnumValues Enumerates the set of values for ListAnalyticsInstancesSortOrderEnum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
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 }
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
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"` }
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
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 }
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
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"` }
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
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 []ListWorkRequestsStatusEnum `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 }
func (request ListWorkRequestsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
ListWorkRequestsResourceTypeEnum Enum with underlying type: string
type ListWorkRequestsResourceTypeEnum string
Set of constants representing the allowable values for ListWorkRequestsResourceTypeEnum
const ( ListWorkRequestsResourceTypeAnalyticsInstance ListWorkRequestsResourceTypeEnum = "ANALYTICS_INSTANCE" )
func GetListWorkRequestsResourceTypeEnumValues() []ListWorkRequestsResourceTypeEnum
GetListWorkRequestsResourceTypeEnumValues Enumerates the set of values for ListWorkRequestsResourceTypeEnum
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
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"` }
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const ( ListWorkRequestsSortById ListWorkRequestsSortByEnum = "id" ListWorkRequestsSortByOperationtype ListWorkRequestsSortByEnum = "operationType" ListWorkRequestsSortByStatus ListWorkRequestsSortByEnum = "status" ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted" ListWorkRequestsSortByTimestarted ListWorkRequestsSortByEnum = "timeStarted" ListWorkRequestsSortByTimefinished ListWorkRequestsSortByEnum = "timeFinished" )
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const ( ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC" ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC" )
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
ListWorkRequestsStatusEnum Enum with underlying type: string
type ListWorkRequestsStatusEnum string
Set of constants representing the allowable values for ListWorkRequestsStatusEnum
const ( ListWorkRequestsStatusAccepted ListWorkRequestsStatusEnum = "ACCEPTED" ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS" ListWorkRequestsStatusFailed ListWorkRequestsStatusEnum = "FAILED" ListWorkRequestsStatusSucceeded ListWorkRequestsStatusEnum = "SUCCEEDED" ListWorkRequestsStatusCanceling ListWorkRequestsStatusEnum = "CANCELING" ListWorkRequestsStatusCanceled ListWorkRequestsStatusEnum = "CANCELED" )
func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum
GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum
NetworkEndpointDetails Base representation of a network endpoint.
type NetworkEndpointDetails interface { }
NetworkEndpointTypeEnum Enum with underlying type: string
type NetworkEndpointTypeEnum string
Set of constants representing the allowable values for NetworkEndpointTypeEnum
const ( NetworkEndpointTypePublic NetworkEndpointTypeEnum = "PUBLIC" NetworkEndpointTypePrivate NetworkEndpointTypeEnum = "PRIVATE" )
func GetNetworkEndpointTypeEnumValues() []NetworkEndpointTypeEnum
GetNetworkEndpointTypeEnumValues Enumerates the set of values for NetworkEndpointTypeEnum
PrivateEndpointDetails Private endpoint configuration details.
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"` }
func (m PrivateEndpointDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PrivateEndpointDetails) String() string
PublicEndpointDetails Public endpoint configuration details.
type PublicEndpointDetails struct { // Source IP addresses or IP address ranges igress rules. WhitelistedIps []string `mandatory:"false" json:"whitelistedIps"` // Virtual Cloud Networks allowed to access this network endpoint. WhitelistedVcns []VirtualCloudNetwork `mandatory:"false" json:"whitelistedVcns"` }
func (m PublicEndpointDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PublicEndpointDetails) String() string
ScaleAnalyticsInstanceDetails Input payload to scale an Analytics instance up or down.
type ScaleAnalyticsInstanceDetails struct { Capacity *Capacity `mandatory:"true" json:"capacity"` }
func (m ScaleAnalyticsInstanceDetails) String() string
ScaleAnalyticsInstanceRequest wrapper for the ScaleAnalyticsInstance operation
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 }
func (request ScaleAnalyticsInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ScaleAnalyticsInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ScaleAnalyticsInstanceRequest) String() string
ScaleAnalyticsInstanceResponse wrapper for the ScaleAnalyticsInstance operation
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"` }
func (response ScaleAnalyticsInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ScaleAnalyticsInstanceResponse) String() string
SortByEnum Enum with underlying type: string
type SortByEnum string
Set of constants representing the allowable values for SortByEnum
const ( SortByCapacityType SortByEnum = "capacityType" SortByCapacityValue SortByEnum = "capacityValue" SortByFeatureSet SortByEnum = "featureSet" SortByLifecycleState SortByEnum = "lifecycleState" SortByName SortByEnum = "name" SortByTimeCreated SortByEnum = "timeCreated" )
func GetSortByEnumValues() []SortByEnum
GetSortByEnumValues Enumerates the set of values for SortByEnum
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const ( SortOrderAsc SortOrderEnum = "ASC" SortOrderDesc SortOrderEnum = "DESC" )
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
StartAnalyticsInstanceRequest wrapper for the StartAnalyticsInstance operation
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 }
func (request StartAnalyticsInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StartAnalyticsInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StartAnalyticsInstanceRequest) String() string
StartAnalyticsInstanceResponse wrapper for the StartAnalyticsInstance operation
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"` }
func (response StartAnalyticsInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StartAnalyticsInstanceResponse) String() string
StopAnalyticsInstanceRequest wrapper for the StopAnalyticsInstance operation
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 }
func (request StopAnalyticsInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StopAnalyticsInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StopAnalyticsInstanceRequest) String() string
StopAnalyticsInstanceResponse wrapper for the StopAnalyticsInstance operation
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"` }
func (response StopAnalyticsInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StopAnalyticsInstanceResponse) String() string
UpdateAnalyticsInstanceDetails Input payload to update an Analytics instance. Fields that are not provided will not be updated.
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"` }
func (m UpdateAnalyticsInstanceDetails) String() string
UpdateAnalyticsInstanceRequest wrapper for the UpdateAnalyticsInstance operation
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 }
func (request UpdateAnalyticsInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateAnalyticsInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateAnalyticsInstanceRequest) String() string
UpdateAnalyticsInstanceResponse wrapper for the UpdateAnalyticsInstance operation
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"` }
func (response UpdateAnalyticsInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateAnalyticsInstanceResponse) String() string
VirtualCloudNetwork Virtual Cloud Network definition.
type VirtualCloudNetwork struct { // The Virtual Cloud Network OCID. Id *string `mandatory:"true" json:"id"` // Source IP addresses or IP address ranges igress rules. WhitelistedIps []string `mandatory:"false" json:"whitelistedIps"` }
func (m VirtualCloudNetwork) String() string
WorkRequest An asynchronous work request.
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"` }
func (m WorkRequest) String() string
WorkRequestActionResultEnum Enum with underlying type: string
type WorkRequestActionResultEnum string
Set of constants representing the allowable values for WorkRequestActionResultEnum
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" WorkRequestActionResultNone WorkRequestActionResultEnum = "NONE" )
func GetWorkRequestActionResultEnumValues() []WorkRequestActionResultEnum
GetWorkRequestActionResultEnumValues Enumerates the set of values for WorkRequestActionResultEnum
WorkRequestError Error encountered during the execution of a work request.
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"` }
func (m WorkRequestError) String() string
WorkRequestLog Log entries related to a specific work request.
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"` }
func (m WorkRequestLog) String() string
WorkRequestOperationTypeEnum Enum with underlying type: string
type WorkRequestOperationTypeEnum string
Set of constants representing the allowable values for WorkRequestOperationTypeEnum
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" )
func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum
GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum
WorkRequestResource The representation of 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"` }
func (m WorkRequestResource) String() string
WorkRequestResourceTypeEnum Enum with underlying type: string
type WorkRequestResourceTypeEnum string
Set of constants representing the allowable values for WorkRequestResourceTypeEnum
const ( WorkRequestResourceTypeAnalyticsInstance WorkRequestResourceTypeEnum = "ANALYTICS_INSTANCE" )
func GetWorkRequestResourceTypeEnumValues() []WorkRequestResourceTypeEnum
GetWorkRequestResourceTypeEnumValues Enumerates the set of values for WorkRequestResourceTypeEnum
WorkRequestSortByEnum Enum with underlying type: string
type WorkRequestSortByEnum string
Set of constants representing the allowable values for WorkRequestSortByEnum
const ( WorkRequestSortById WorkRequestSortByEnum = "id" WorkRequestSortByOperationType WorkRequestSortByEnum = "operationType" WorkRequestSortByStatus WorkRequestSortByEnum = "status" WorkRequestSortByTimeAccepted WorkRequestSortByEnum = "timeAccepted" WorkRequestSortByTimeStarted WorkRequestSortByEnum = "timeStarted" WorkRequestSortByTimeFinished WorkRequestSortByEnum = "timeFinished" )
func GetWorkRequestSortByEnumValues() []WorkRequestSortByEnum
GetWorkRequestSortByEnumValues Enumerates the set of values for WorkRequestSortByEnum
WorkRequestStatusEnum Enum with underlying type: string
type WorkRequestStatusEnum string
Set of constants representing the allowable values for WorkRequestStatusEnum
const ( WorkRequestStatusAccepted WorkRequestStatusEnum = "ACCEPTED" WorkRequestStatusInProgress WorkRequestStatusEnum = "IN_PROGRESS" WorkRequestStatusFailed WorkRequestStatusEnum = "FAILED" WorkRequestStatusSucceeded WorkRequestStatusEnum = "SUCCEEDED" WorkRequestStatusCanceling WorkRequestStatusEnum = "CANCELING" WorkRequestStatusCanceled WorkRequestStatusEnum = "CANCELED" )
func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum
GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum
WorkRequestSummary An asynchronous work request.
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"` }
func (m WorkRequestSummary) String() string