func GetAccessControlServiceTypeEnumStringValues() []string
GetAccessControlServiceTypeEnumStringValues Enumerates the set of values in String for AccessControlServiceTypeEnum
func GetAnalyticsInstanceLifecycleStateEnumStringValues() []string
GetAnalyticsInstanceLifecycleStateEnumStringValues Enumerates the set of values in String for AnalyticsInstanceLifecycleStateEnum
func GetCapacityTypeEnumStringValues() []string
GetCapacityTypeEnumStringValues Enumerates the set of values in String for CapacityTypeEnum
func GetFeatureSetEnumStringValues() []string
GetFeatureSetEnumStringValues Enumerates the set of values in String for FeatureSetEnum
func GetLicenseTypeEnumStringValues() []string
GetLicenseTypeEnumStringValues Enumerates the set of values in String for LicenseTypeEnum
func GetListAnalyticsInstancesCapacityTypeEnumStringValues() []string
GetListAnalyticsInstancesCapacityTypeEnumStringValues Enumerates the set of values in String for ListAnalyticsInstancesCapacityTypeEnum
func GetListAnalyticsInstancesFeatureSetEnumStringValues() []string
GetListAnalyticsInstancesFeatureSetEnumStringValues Enumerates the set of values in String for ListAnalyticsInstancesFeatureSetEnum
func GetListAnalyticsInstancesLifecycleStateEnumStringValues() []string
GetListAnalyticsInstancesLifecycleStateEnumStringValues Enumerates the set of values in String for ListAnalyticsInstancesLifecycleStateEnum
func GetListAnalyticsInstancesSortByEnumStringValues() []string
GetListAnalyticsInstancesSortByEnumStringValues Enumerates the set of values in String for ListAnalyticsInstancesSortByEnum
func GetListAnalyticsInstancesSortOrderEnumStringValues() []string
GetListAnalyticsInstancesSortOrderEnumStringValues Enumerates the set of values in String for ListAnalyticsInstancesSortOrderEnum
func GetListWorkRequestsResourceTypeEnumStringValues() []string
GetListWorkRequestsResourceTypeEnumStringValues Enumerates the set of values in String for ListWorkRequestsResourceTypeEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetNetworkEndpointTypeEnumStringValues() []string
GetNetworkEndpointTypeEnumStringValues Enumerates the set of values in String for NetworkEndpointTypeEnum
func GetSortByEnumStringValues() []string
GetSortByEnumStringValues Enumerates the set of values in String for SortByEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetWorkRequestActionResultEnumStringValues() []string
GetWorkRequestActionResultEnumStringValues Enumerates the set of values in String for WorkRequestActionResultEnum
func GetWorkRequestOperationTypeEnumStringValues() []string
GetWorkRequestOperationTypeEnumStringValues Enumerates the set of values in String for WorkRequestOperationTypeEnum
func GetWorkRequestResourceTypeEnumStringValues() []string
GetWorkRequestResourceTypeEnumStringValues Enumerates the set of values in String for WorkRequestResourceTypeEnum
func GetWorkRequestSortByEnumStringValues() []string
GetWorkRequestSortByEnumStringValues Enumerates the set of values in String for WorkRequestSortByEnum
func GetWorkRequestStatusEnumStringValues() []string
GetWorkRequestStatusEnumStringValues Enumerates the set of values in String for WorkRequestStatusEnum
AccessControlServiceTypeEnum Enum with underlying type: string
type AccessControlServiceTypeEnum string
Set of constants representing the allowable values for AccessControlServiceTypeEnum
const (
AccessControlServiceTypeAll AccessControlServiceTypeEnum = "ALL"
)
func GetAccessControlServiceTypeEnumValues() []AccessControlServiceTypeEnum
GetAccessControlServiceTypeEnumValues Enumerates the set of values for AccessControlServiceTypeEnum
func GetMappingAccessControlServiceTypeEnum(val string) (AccessControlServiceTypeEnum, bool)
GetMappingAccessControlServiceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
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.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/ChangeAnalyticsInstanceCompartment.go.html to see an example of how to use ChangeAnalyticsInstanceCompartment API. A default retry strategy applies to this operation ChangeAnalyticsInstanceCompartment()
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/65.63.2/analytics/ChangeAnalyticsInstanceNetworkEndpoint.go.html to see an example of how to use ChangeAnalyticsInstanceNetworkEndpoint API. A default retry strategy applies to this operation ChangeAnalyticsInstanceNetworkEndpoint()
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.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/CreateAnalyticsInstance.go.html to see an example of how to use CreateAnalyticsInstance API. A default retry strategy applies to this operation CreateAnalyticsInstance()
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/65.63.2/analytics/CreatePrivateAccessChannel.go.html to see an example of how to use CreatePrivateAccessChannel API. A default retry strategy applies to this operation CreatePrivateAccessChannel()
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/65.63.2/analytics/CreateVanityUrl.go.html to see an example of how to use CreateVanityUrl API. A default retry strategy applies to this operation CreateVanityUrl()
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/65.63.2/analytics/DeleteAnalyticsInstance.go.html to see an example of how to use DeleteAnalyticsInstance API. A default retry strategy applies to this operation DeleteAnalyticsInstance()
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/65.63.2/analytics/DeletePrivateAccessChannel.go.html to see an example of how to use DeletePrivateAccessChannel API. A default retry strategy applies to this operation DeletePrivateAccessChannel()
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/65.63.2/analytics/DeleteVanityUrl.go.html to see an example of how to use DeleteVanityUrl API. A default retry strategy applies to this operation DeleteVanityUrl()
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/65.63.2/analytics/DeleteWorkRequest.go.html to see an example of how to use DeleteWorkRequest API.
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/65.63.2/analytics/GetAnalyticsInstance.go.html to see an example of how to use GetAnalyticsInstance API. A default retry strategy applies to this operation GetAnalyticsInstance()
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/65.63.2/analytics/GetPrivateAccessChannel.go.html to see an example of how to use GetPrivateAccessChannel API. A default retry strategy applies to this operation GetPrivateAccessChannel()
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/65.63.2/analytics/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
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/65.63.2/analytics/ListAnalyticsInstances.go.html to see an example of how to use ListAnalyticsInstances API. A default retry strategy applies to this operation ListAnalyticsInstances()
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/65.63.2/analytics/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
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/65.63.2/analytics/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
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/65.63.2/analytics/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
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/65.63.2/analytics/ScaleAnalyticsInstance.go.html to see an example of how to use ScaleAnalyticsInstance API. A default retry strategy applies to this operation ScaleAnalyticsInstance()
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/65.63.2/analytics/SetKmsKey.go.html to see an example of how to use SetKmsKey API. A default retry strategy applies to this operation SetKmsKey()
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.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/StartAnalyticsInstance.go.html to see an example of how to use StartAnalyticsInstance API. A default retry strategy applies to this operation StartAnalyticsInstance()
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/65.63.2/analytics/StopAnalyticsInstance.go.html to see an example of how to use StopAnalyticsInstance API. A default retry strategy applies to this operation StopAnalyticsInstance()
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/65.63.2/analytics/UpdateAnalyticsInstance.go.html to see an example of how to use UpdateAnalyticsInstance API.
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/65.63.2/analytics/UpdatePrivateAccessChannel.go.html to see an example of how to use UpdatePrivateAccessChannel API. A default retry strategy applies to this operation UpdatePrivateAccessChannel()
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/65.63.2/analytics/UpdateVanityUrl.go.html to see an example of how to use UpdateVanityUrl API. A default retry strategy applies to this operation UpdateVanityUrl()
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"`
// 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"`
}
func (m AnalyticsInstance) String() string
func (m *AnalyticsInstance) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
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
func GetMappingAnalyticsInstanceLifecycleStateEnum(val string) (AnalyticsInstanceLifecycleStateEnum, bool)
GetMappingAnalyticsInstanceLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
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
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
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
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
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
func GetMappingCapacityTypeEnum(val string) (CapacityTypeEnum, bool)
GetMappingCapacityTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ChangeAnalyticsInstanceCompartmentRequest wrapper for the ChangeAnalyticsInstanceCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/ChangeAnalyticsInstanceCompartment.go.html to see an example of how to use 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
}
func (request ChangeAnalyticsInstanceCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeAnalyticsInstanceCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
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
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
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
ChangeAnalyticsInstanceNetworkEndpointRequest wrapper for the ChangeAnalyticsInstanceNetworkEndpoint operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/ChangeAnalyticsInstanceNetworkEndpoint.go.html to see an example of how to use 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
}
func (request ChangeAnalyticsInstanceNetworkEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeAnalyticsInstanceNetworkEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
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
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
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
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"`
// 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"`
}
func (m CreateAnalyticsInstanceDetails) String() string
func (m *CreateAnalyticsInstanceDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
CreateAnalyticsInstanceRequest wrapper for the CreateAnalyticsInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/CreateAnalyticsInstance.go.html to see an example of how to use 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
}
func (request CreateAnalyticsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateAnalyticsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
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
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
CreatePrivateAccessChannelDetails Input payload to create a Private Access Channel.
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"`
}
func (m CreatePrivateAccessChannelDetails) String() string
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
CreatePrivateAccessChannelRequest wrapper for the CreatePrivateAccessChannel operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/CreatePrivateAccessChannel.go.html to see an example of how to use 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
}
func (request CreatePrivateAccessChannelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreatePrivateAccessChannelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreatePrivateAccessChannelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreatePrivateAccessChannelRequest) String() string
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
CreatePrivateAccessChannelResponse wrapper for the CreatePrivateAccessChannel operation
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"`
}
func (response CreatePrivateAccessChannelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreatePrivateAccessChannelResponse) String() string
CreateVanityUrlDetails Input payload to create a vanity url.
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"`
}
func (m CreateVanityUrlDetails) String() string
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
CreateVanityUrlRequest wrapper for the CreateVanityUrl operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/CreateVanityUrl.go.html to see an example of how to use 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
}
func (request CreateVanityUrlRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateVanityUrlRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateVanityUrlRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateVanityUrlRequest) String() string
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
CreateVanityUrlResponse wrapper for the CreateVanityUrl operation
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"`
}
func (response CreateVanityUrlResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateVanityUrlResponse) String() string
DeleteAnalyticsInstanceRequest wrapper for the DeleteAnalyticsInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/DeleteAnalyticsInstance.go.html to see an example of how to use 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
}
func (request DeleteAnalyticsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteAnalyticsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
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
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
DeletePrivateAccessChannelRequest wrapper for the DeletePrivateAccessChannel operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/DeletePrivateAccessChannel.go.html to see an example of how to use 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
}
func (request DeletePrivateAccessChannelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeletePrivateAccessChannelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeletePrivateAccessChannelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeletePrivateAccessChannelRequest) String() string
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
DeletePrivateAccessChannelResponse wrapper for the DeletePrivateAccessChannel operation
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"`
}
func (response DeletePrivateAccessChannelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeletePrivateAccessChannelResponse) String() string
DeleteVanityUrlRequest wrapper for the DeleteVanityUrl operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/DeleteVanityUrl.go.html to see an example of how to use 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
}
func (request DeleteVanityUrlRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteVanityUrlRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteVanityUrlRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteVanityUrlRequest) String() string
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
DeleteVanityUrlResponse wrapper for the DeleteVanityUrl operation
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"`
}
func (response DeleteVanityUrlResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteVanityUrlResponse) String() string
DeleteWorkRequestRequest wrapper for the DeleteWorkRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/DeleteWorkRequest.go.html to see an example of how to use 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
}
func (request DeleteWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
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
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
func GetMappingFeatureSetEnum(val string) (FeatureSetEnum, bool)
GetMappingFeatureSetEnum performs case Insensitive comparison on enum value and return the desired enum
GetAnalyticsInstanceRequest wrapper for the GetAnalyticsInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/GetAnalyticsInstance.go.html to see an example of how to use 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
}
func (request GetAnalyticsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAnalyticsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
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
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
GetPrivateAccessChannelRequest wrapper for the GetPrivateAccessChannel operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/GetPrivateAccessChannel.go.html to see an example of how to use 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
}
func (request GetPrivateAccessChannelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetPrivateAccessChannelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetPrivateAccessChannelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetPrivateAccessChannelRequest) String() string
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
GetPrivateAccessChannelResponse wrapper for the GetPrivateAccessChannel operation
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"`
}
func (response GetPrivateAccessChannelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetPrivateAccessChannelResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/GetWorkRequest.go.html to see an example of how to use 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
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
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
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
func GetMappingLicenseTypeEnum(val string) (LicenseTypeEnum, bool)
GetMappingLicenseTypeEnum performs case Insensitive comparison on enum value and return the desired enum
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
func GetMappingListAnalyticsInstancesCapacityTypeEnum(val string) (ListAnalyticsInstancesCapacityTypeEnum, bool)
GetMappingListAnalyticsInstancesCapacityTypeEnum performs case Insensitive comparison on enum value and return the desired enum
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
func GetMappingListAnalyticsInstancesFeatureSetEnum(val string) (ListAnalyticsInstancesFeatureSetEnum, bool)
GetMappingListAnalyticsInstancesFeatureSetEnum performs case Insensitive comparison on enum value and return the desired enum
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
func GetMappingListAnalyticsInstancesLifecycleStateEnum(val string) (ListAnalyticsInstancesLifecycleStateEnum, bool)
GetMappingListAnalyticsInstancesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListAnalyticsInstancesRequest wrapper for the ListAnalyticsInstances operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/ListAnalyticsInstances.go.html to see an example of how to use 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
}
func (request ListAnalyticsInstancesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAnalyticsInstancesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
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
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
func GetMappingListAnalyticsInstancesSortByEnum(val string) (ListAnalyticsInstancesSortByEnum, bool)
GetMappingListAnalyticsInstancesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
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
func GetMappingListAnalyticsInstancesSortOrderEnum(val string) (ListAnalyticsInstancesSortOrderEnum, bool)
GetMappingListAnalyticsInstancesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/ListWorkRequestErrors.go.html to see an example of how to use 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
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
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
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
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/ListWorkRequestLogs.go.html to see an example of how to use 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
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
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
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
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/ListWorkRequests.go.html to see an example of how to use 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
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
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
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
func GetMappingListWorkRequestsResourceTypeEnum(val string) (ListWorkRequestsResourceTypeEnum, bool)
GetMappingListWorkRequestsResourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
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
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
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
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
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 GetMappingNetworkEndpointTypeEnum(val string) (NetworkEndpointTypeEnum, bool)
GetMappingNetworkEndpointTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNetworkEndpointTypeEnumValues() []NetworkEndpointTypeEnum
GetNetworkEndpointTypeEnumValues Enumerates the set of values for NetworkEndpointTypeEnum
PrivateAccessChannel Analytics Instance Private Access Channel model.
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"`
}
func (m PrivateAccessChannel) String() string
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
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"`
// Network Security Group OCIDs for an Analytics instance.
NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`
}
func (m PrivateEndpointDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PrivateEndpointDetails) String() string
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
PrivateSourceDnsZone Private source DNS Zone model.
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"`
}
func (m PrivateSourceDnsZone) String() string
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
PrivateSourceScanHost Private source Scan Hostname model.
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"`
}
func (m PrivateSourceScanHost) String() string
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
PublicEndpointDetails Public endpoint configuration details.
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"`
}
func (m PublicEndpointDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PublicEndpointDetails) String() string
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
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
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
ScaleAnalyticsInstanceRequest wrapper for the ScaleAnalyticsInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/ScaleAnalyticsInstance.go.html to see an example of how to use 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
}
func (request ScaleAnalyticsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ScaleAnalyticsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
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
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
SetKmsKeyDetails Input payload to reset the OCI Vault encryption key.
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"`
}
func (m SetKmsKeyDetails) String() string
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
SetKmsKeyRequest wrapper for the SetKmsKey operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/SetKmsKey.go.html to see an example of how to use 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
}
func (request SetKmsKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request SetKmsKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request SetKmsKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request SetKmsKeyRequest) String() string
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
SetKmsKeyResponse wrapper for the SetKmsKey operation
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"`
}
func (response SetKmsKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response SetKmsKeyResponse) 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 GetMappingSortByEnum(val string) (SortByEnum, bool)
GetMappingSortByEnum performs case Insensitive comparison on enum value and return the desired enum
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 GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
StartAnalyticsInstanceRequest wrapper for the StartAnalyticsInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/StartAnalyticsInstance.go.html to see an example of how to use 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
}
func (request StartAnalyticsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StartAnalyticsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
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
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
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/StopAnalyticsInstance.go.html to see an example of how to use 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
}
func (request StopAnalyticsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StopAnalyticsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
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
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
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
UpdateAnalyticsInstanceRequest wrapper for the UpdateAnalyticsInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/UpdateAnalyticsInstance.go.html to see an example of how to use 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
}
func (request UpdateAnalyticsInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateAnalyticsInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
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
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
UpdatePrivateAccessChannelDetails Input payload to update a Private Access Channel.
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"`
}
func (m UpdatePrivateAccessChannelDetails) String() string
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
UpdatePrivateAccessChannelRequest wrapper for the UpdatePrivateAccessChannel operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/UpdatePrivateAccessChannel.go.html to see an example of how to use 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
}
func (request UpdatePrivateAccessChannelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdatePrivateAccessChannelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdatePrivateAccessChannelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdatePrivateAccessChannelRequest) String() string
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
UpdatePrivateAccessChannelResponse wrapper for the UpdatePrivateAccessChannel operation
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"`
}
func (response UpdatePrivateAccessChannelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdatePrivateAccessChannelResponse) String() string
UpdateVanityUrlDetails Input payload to update a vanity url.
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"`
}
func (m UpdateVanityUrlDetails) String() string
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
UpdateVanityUrlRequest wrapper for the UpdateVanityUrl operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/analytics/UpdateVanityUrl.go.html to see an example of how to use 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
}
func (request UpdateVanityUrlRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateVanityUrlRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateVanityUrlRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateVanityUrlRequest) String() string
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
UpdateVanityUrlResponse wrapper for the UpdateVanityUrl operation
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"`
}
func (response UpdateVanityUrlResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateVanityUrlResponse) String() string
VanityUrlDetails Vanity url configuration details.
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"`
}
func (m VanityUrlDetails) String() string
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
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 in ingress rules.
WhitelistedIps []string `mandatory:"false" json:"whitelistedIps"`
}
func (m VirtualCloudNetwork) String() string
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
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
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
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"
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"
)
func GetMappingWorkRequestActionResultEnum(val string) (WorkRequestActionResultEnum, bool)
GetMappingWorkRequestActionResultEnum performs case Insensitive comparison on enum value and return the desired enum
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
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
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
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
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"
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"
)
func GetMappingWorkRequestOperationTypeEnum(val string) (WorkRequestOperationTypeEnum, bool)
GetMappingWorkRequestOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
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
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
WorkRequestResourceTypeEnum Enum with underlying type: string
type WorkRequestResourceTypeEnum string
Set of constants representing the allowable values for WorkRequestResourceTypeEnum
const (
WorkRequestResourceTypeAnalyticsInstance WorkRequestResourceTypeEnum = "ANALYTICS_INSTANCE"
)
func GetMappingWorkRequestResourceTypeEnum(val string) (WorkRequestResourceTypeEnum, bool)
GetMappingWorkRequestResourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
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 GetMappingWorkRequestSortByEnum(val string) (WorkRequestSortByEnum, bool)
GetMappingWorkRequestSortByEnum performs case Insensitive comparison on enum value and return the desired enum
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 GetMappingWorkRequestStatusEnum(val string) (WorkRequestStatusEnum, bool)
GetMappingWorkRequestStatusEnum performs case Insensitive comparison on enum value and return the desired enum
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
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