func GetActionTypesEnumStringValues() []string
GetActionTypesEnumStringValues Enumerates the set of values in String for ActionTypesEnum
func GetDataKeyTypesEnumStringValues() []string
GetDataKeyTypesEnumStringValues Enumerates the set of values in String for DataKeyTypesEnum
func GetLifecycleStatesEnumStringValues() []string
GetLifecycleStatesEnumStringValues Enumerates the set of values in String for LifecycleStatesEnum
func GetListApmDomainsLifecycleStateEnumStringValues() []string
GetListApmDomainsLifecycleStateEnumStringValues Enumerates the set of values in String for ListApmDomainsLifecycleStateEnum
func GetListApmDomainsSortByEnumStringValues() []string
GetListApmDomainsSortByEnumStringValues Enumerates the set of values in String for ListApmDomainsSortByEnum
func GetListApmDomainsSortOrderEnumStringValues() []string
GetListApmDomainsSortOrderEnumStringValues Enumerates the set of values in String for ListApmDomainsSortOrderEnum
func GetListDataKeysDataKeyTypeEnumStringValues() []string
GetListDataKeysDataKeyTypeEnumStringValues Enumerates the set of values in String for ListDataKeysDataKeyTypeEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypesEnumStringValues() []string
GetOperationTypesEnumStringValues Enumerates the set of values in String for OperationTypesEnum
func GetSortOrdersEnumStringValues() []string
GetSortOrdersEnumStringValues Enumerates the set of values in String for SortOrdersEnum
ActionTypesEnum Enum with underlying type: string
type ActionTypesEnum string
Set of constants representing the allowable values for ActionTypesEnum
const (
ActionTypesCreated ActionTypesEnum = "CREATED"
ActionTypesUpdated ActionTypesEnum = "UPDATED"
ActionTypesDeleted ActionTypesEnum = "DELETED"
ActionTypesInProgress ActionTypesEnum = "IN_PROGRESS"
ActionTypesRelated ActionTypesEnum = "RELATED"
)
func GetActionTypesEnumValues() []ActionTypesEnum
GetActionTypesEnumValues Enumerates the set of values for ActionTypesEnum
func GetMappingActionTypesEnum(val string) (ActionTypesEnum, bool)
GetMappingActionTypesEnum performs case Insensitive comparison on enum value and return the desired enum
ApmDomain Details of an APM domain.
type ApmDomain struct {
// Unique identifier that is immutable on creation.
Id *string `mandatory:"true" json:"id"`
// Display name of the APM domain, which can be updated.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the compartment corresponding to the APM domain.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Description of the APM domain.
Description *string `mandatory:"false" json:"description"`
// The current lifecycle state of the APM domain.
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Indicates if this is an Always Free resource.
IsFreeTier *bool `mandatory:"false" json:"isFreeTier"`
// The time the APM domain was created, expressed in RFC 3339 timestamp format.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the APM domain was updated, expressed in RFC 3339 timestamp format.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The endpoint where the APM agents upload their observations and metrics.
DataUploadEndpoint *string `mandatory:"false" json:"dataUploadEndpoint"`
}
func (m ApmDomain) String() string
func (m ApmDomain) 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
ApmDomainClient a client for ApmDomain
type ApmDomainClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewApmDomainClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ApmDomainClient, err error)
NewApmDomainClientWithConfigurationProvider Creates a new default ApmDomain client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewApmDomainClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ApmDomainClient, err error)
NewApmDomainClientWithOboToken Creates a new default ApmDomain 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 ApmDomainClient) ChangeApmDomainCompartment(ctx context.Context, request ChangeApmDomainCompartmentRequest) (response ChangeApmDomainCompartmentResponse, err error)
ChangeApmDomainCompartment Moves an APM domain into a different compartment. When provided, If-Match is checked against ETag values of the APM domain.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/ChangeApmDomainCompartment.go.html to see an example of how to use ChangeApmDomainCompartment API. A default retry strategy applies to this operation ChangeApmDomainCompartment()
func (client *ApmDomainClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ApmDomainClient) CreateApmDomain(ctx context.Context, request CreateApmDomainRequest) (response CreateApmDomainResponse, err error)
CreateApmDomain Creates a new APM domain.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/CreateApmDomain.go.html to see an example of how to use CreateApmDomain API. A default retry strategy applies to this operation CreateApmDomain()
func (client ApmDomainClient) DeleteApmDomain(ctx context.Context, request DeleteApmDomainRequest) (response DeleteApmDomainResponse, err error)
DeleteApmDomain Deletes the specified APM domain asynchronously. The APM domain is placed in the 'Deleting' state and will stop accepting any operation requests. All resources associated with the APM domain are eventually recovered. Use the returned work request ID to track the progress of the background activity to complete deleting the APM domain.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/DeleteApmDomain.go.html to see an example of how to use DeleteApmDomain API. A default retry strategy applies to this operation DeleteApmDomain()
func (client ApmDomainClient) GenerateDataKeys(ctx context.Context, request GenerateDataKeysRequest) (response GenerateDataKeysResponse, err error)
GenerateDataKeys Generates a set of new Data Keys for the specified APM domain with the specified names and types. These will be added to the existing set of Data Keys for the specified APM domain.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/GenerateDataKeys.go.html to see an example of how to use GenerateDataKeys API. A default retry strategy applies to this operation GenerateDataKeys()
func (client ApmDomainClient) GetApmDomain(ctx context.Context, request GetApmDomainRequest) (response GetApmDomainResponse, err error)
GetApmDomain Gets the details of the APM domain specified by OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/GetApmDomain.go.html to see an example of how to use GetApmDomain API. A default retry strategy applies to this operation GetApmDomain()
func (client ApmDomainClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the details of the work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client ApmDomainClient) ListApmDomainWorkRequests(ctx context.Context, request ListApmDomainWorkRequestsRequest) (response ListApmDomainWorkRequestsResponse, err error)
ListApmDomainWorkRequests Returns a (paginated) list of work requests related to a specific APM domain.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/ListApmDomainWorkRequests.go.html to see an example of how to use ListApmDomainWorkRequests API. A default retry strategy applies to this operation ListApmDomainWorkRequests()
func (client ApmDomainClient) ListApmDomains(ctx context.Context, request ListApmDomainsRequest) (response ListApmDomainsResponse, err error)
ListApmDomains Lists all APM domains for the specified tenant compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/ListApmDomains.go.html to see an example of how to use ListApmDomains API. A default retry strategy applies to this operation ListApmDomains()
func (client ApmDomainClient) ListDataKeys(ctx context.Context, request ListDataKeysRequest) (response ListDataKeysResponse, err error)
ListDataKeys Lists all Data Keys for the specified APM domain. The caller may filter the list by specifying the 'dataKeyType' query parameter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/ListDataKeys.go.html to see an example of how to use ListDataKeys API. A default retry strategy applies to this operation ListDataKeys()
func (client ApmDomainClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Returns a (paginated) list of errors for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client ApmDomainClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Returns a (paginated) list of logs for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client ApmDomainClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Returns a (paginated) list of work requests in a given compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client ApmDomainClient) RemoveDataKeys(ctx context.Context, request RemoveDataKeysRequest) (response RemoveDataKeysResponse, err error)
RemoveDataKeys Removes the set of specified Data Keys from the specified APM domain. Agents would no longer be able to use these data keys to upload to the APM domain once this operation is completed.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/RemoveDataKeys.go.html to see an example of how to use RemoveDataKeys API. A default retry strategy applies to this operation RemoveDataKeys()
func (client *ApmDomainClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client ApmDomainClient) UpdateApmDomain(ctx context.Context, request UpdateApmDomainRequest) (response UpdateApmDomainResponse, err error)
UpdateApmDomain Updates the APM domain.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/UpdateApmDomain.go.html to see an example of how to use UpdateApmDomain API. A default retry strategy applies to this operation UpdateApmDomain()
ApmDomainSummary Summary of an APM domain.
type ApmDomainSummary struct {
// Unique identifier that is immutable on creation.
Id *string `mandatory:"true" json:"id"`
// Display name of the APM domain, which can be updated.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the compartment corresponding to the APM domain.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Description of the APM domain.
Description *string `mandatory:"false" json:"description"`
// The current lifecycle state of the APM domain.
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Indicates if this is an Always Free resource.
IsFreeTier *bool `mandatory:"false" json:"isFreeTier"`
// The time the APM domain was created, expressed in RFC 3339 timestamp format.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the APM domain was updated, expressed in RFC 3339 timestamp format.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m ApmDomainSummary) String() string
func (m ApmDomainSummary) 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
BaseDomainDetails Details for an APM domain.
type BaseDomainDetails struct {
// Unique identifier that is immutable on creation.
Id *string `mandatory:"true" json:"id"`
// Display name of the APM domain, which can be updated.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the compartment corresponding to the APM domain.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Description of the APM domain.
Description *string `mandatory:"false" json:"description"`
// The current lifecycle state of the APM domain.
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Indicates if this is an Always Free resource.
IsFreeTier *bool `mandatory:"false" json:"isFreeTier"`
// The time the APM domain was created, expressed in RFC 3339 timestamp format.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the APM domain was updated, expressed in RFC 3339 timestamp format.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m BaseDomainDetails) String() string
func (m BaseDomainDetails) 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
BaseKeyDetails The information about a Data Key.
type BaseKeyDetails struct {
// Name of the Data Key. The name uniquely identifies a Data Key within an APM domain.
Name *string `mandatory:"true" json:"name"`
// Type of the Data Key.
Type DataKeyTypesEnum `mandatory:"true" json:"type"`
}
func (m BaseKeyDetails) String() string
func (m BaseKeyDetails) 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
ChangeApmDomainCompartmentDetails The information needed for the change compartment operation.
type ChangeApmDomainCompartmentDetails struct {
// The OCID of the destination compartment for the APM domain.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeApmDomainCompartmentDetails) String() string
func (m ChangeApmDomainCompartmentDetails) 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
ChangeApmDomainCompartmentRequest wrapper for the ChangeApmDomainCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/ChangeApmDomainCompartment.go.html to see an example of how to use ChangeApmDomainCompartmentRequest.
type ChangeApmDomainCompartmentRequest struct {
// The OCID of the APM domain.
ApmDomainId *string `mandatory:"true" contributesTo:"path" name:"apmDomainId"`
// The information to be used in changing compartment.
ChangeApmDomainCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. 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"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request therefore 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
// might 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 ChangeApmDomainCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeApmDomainCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeApmDomainCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeApmDomainCompartmentRequest) String() string
func (request ChangeApmDomainCompartmentRequest) 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
ChangeApmDomainCompartmentResponse wrapper for the ChangeApmDomainCompartment operation
type ChangeApmDomainCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 ChangeApmDomainCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeApmDomainCompartmentResponse) String() string
CreateApmDomainDetails The information about the new APM domain.
type CreateApmDomainDetails struct {
// Display name of the APM domain.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the compartment corresponding to the APM domain.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Description of the APM domain.
Description *string `mandatory:"false" json:"description"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Indicates whether this is an "Always Free" resource. The default value is false.
IsFreeTier *bool `mandatory:"false" json:"isFreeTier"`
}
func (m CreateApmDomainDetails) String() string
func (m CreateApmDomainDetails) 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
CreateApmDomainRequest wrapper for the CreateApmDomain operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/CreateApmDomain.go.html to see an example of how to use CreateApmDomainRequest.
type CreateApmDomainRequest struct {
// Details for the new APM domain.
CreateApmDomainDetails `contributesTo:"body"`
// A token that uniquely identifies a request therefore 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
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
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 CreateApmDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateApmDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateApmDomainRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateApmDomainRequest) String() string
func (request CreateApmDomainRequest) 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
CreateApmDomainResponse wrapper for the CreateApmDomain operation
type CreateApmDomainResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 CreateApmDomainResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateApmDomainResponse) String() string
DataKey The information about a Data Key, including the Data Key's value.
type DataKey struct {
// Name of the Data Key. The name uniquely identifies a Data Key within an APM domain.
Name *string `mandatory:"true" json:"name"`
// Type of the Data Key.
Type DataKeyTypesEnum `mandatory:"true" json:"type"`
// Value of the Data Key.
Value *string `mandatory:"false" json:"value"`
}
func (m DataKey) String() string
func (m DataKey) 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
DataKeySummary Summary of Data Key.
type DataKeySummary struct {
// Name of the Data Key. The name uniquely identifies a Data Key within an APM domain.
Name *string `mandatory:"true" json:"name"`
// Type of the Data Key.
Type DataKeyTypesEnum `mandatory:"true" json:"type"`
// Value of the Data Key.
Value *string `mandatory:"false" json:"value"`
}
func (m DataKeySummary) String() string
func (m DataKeySummary) 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
DataKeyTypesEnum Enum with underlying type: string
type DataKeyTypesEnum string
Set of constants representing the allowable values for DataKeyTypesEnum
const (
DataKeyTypesPrivate DataKeyTypesEnum = "PRIVATE"
DataKeyTypesPublic DataKeyTypesEnum = "PUBLIC"
)
func GetDataKeyTypesEnumValues() []DataKeyTypesEnum
GetDataKeyTypesEnumValues Enumerates the set of values for DataKeyTypesEnum
func GetMappingDataKeyTypesEnum(val string) (DataKeyTypesEnum, bool)
GetMappingDataKeyTypesEnum performs case Insensitive comparison on enum value and return the desired enum
DeleteApmDomainRequest wrapper for the DeleteApmDomain operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/DeleteApmDomain.go.html to see an example of how to use DeleteApmDomainRequest.
type DeleteApmDomainRequest struct {
// The OCID of the APM domain.
ApmDomainId *string `mandatory:"true" contributesTo:"path" name:"apmDomainId"`
// For optimistic concurrency control. 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"`
// The client request ID for tracing.
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 DeleteApmDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteApmDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteApmDomainRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteApmDomainRequest) String() string
func (request DeleteApmDomainRequest) 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
DeleteApmDomainResponse wrapper for the DeleteApmDomain operation
type DeleteApmDomainResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 DeleteApmDomainResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteApmDomainResponse) String() string
GenerateDataKeyDetails Details of the Data Key to be generated.
type GenerateDataKeyDetails struct {
// Name of the Data Key. The name uniquely identifies a Data Key within an APM domain.
Name *string `mandatory:"true" json:"name"`
// Type of the Data Key.
Type DataKeyTypesEnum `mandatory:"true" json:"type"`
}
func (m GenerateDataKeyDetails) String() string
func (m GenerateDataKeyDetails) 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
GenerateDataKeysRequest wrapper for the GenerateDataKeys operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/GenerateDataKeys.go.html to see an example of how to use GenerateDataKeysRequest.
type GenerateDataKeysRequest struct {
// List of new Data Keys to be generated.
GenerateDataKeysListDetails []GenerateDataKeyDetails `contributesTo:"body"`
// The OCID of the APM domain.
ApmDomainId *string `mandatory:"true" contributesTo:"path" name:"apmDomainId"`
// For optimistic concurrency control. 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"`
// The client request ID for tracing.
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 GenerateDataKeysRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GenerateDataKeysRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GenerateDataKeysRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GenerateDataKeysRequest) String() string
func (request GenerateDataKeysRequest) 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
GenerateDataKeysResponse wrapper for the GenerateDataKeys operation
type GenerateDataKeysResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 GenerateDataKeysResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GenerateDataKeysResponse) String() string
GetApmDomainRequest wrapper for the GetApmDomain operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/GetApmDomain.go.html to see an example of how to use GetApmDomainRequest.
type GetApmDomainRequest struct {
// The OCID of the APM domain.
ApmDomainId *string `mandatory:"true" contributesTo:"path" name:"apmDomainId"`
// The client request ID for tracing.
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 GetApmDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetApmDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetApmDomainRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetApmDomainRequest) String() string
func (request GetApmDomainRequest) 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
GetApmDomainResponse wrapper for the GetApmDomain operation
type GetApmDomainResponse struct {
// The underlying http response
RawResponse *http.Response
// The ApmDomain instance
ApmDomain `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 GetApmDomainResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetApmDomainResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
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"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *float32 `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
LifecycleStatesEnum Enum with underlying type: string
type LifecycleStatesEnum string
Set of constants representing the allowable values for LifecycleStatesEnum
const (
LifecycleStatesCreating LifecycleStatesEnum = "CREATING"
LifecycleStatesUpdating LifecycleStatesEnum = "UPDATING"
LifecycleStatesActive LifecycleStatesEnum = "ACTIVE"
LifecycleStatesDeleting LifecycleStatesEnum = "DELETING"
LifecycleStatesDeleted LifecycleStatesEnum = "DELETED"
LifecycleStatesFailed LifecycleStatesEnum = "FAILED"
)
func GetLifecycleStatesEnumValues() []LifecycleStatesEnum
GetLifecycleStatesEnumValues Enumerates the set of values for LifecycleStatesEnum
func GetMappingLifecycleStatesEnum(val string) (LifecycleStatesEnum, bool)
GetMappingLifecycleStatesEnum performs case Insensitive comparison on enum value and return the desired enum
ListApmDomainWorkRequestsRequest wrapper for the ListApmDomainWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/ListApmDomainWorkRequests.go.html to see an example of how to use ListApmDomainWorkRequestsRequest.
type ListApmDomainWorkRequestsRequest struct {
// The OCID of the APM domain.
ApmDomainId *string `mandatory:"true" contributesTo:"path" name:"apmDomainId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// 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 ListApmDomainWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListApmDomainWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListApmDomainWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListApmDomainWorkRequestsRequest) String() string
func (request ListApmDomainWorkRequestsRequest) 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
ListApmDomainWorkRequestsResponse wrapper for the ListApmDomainWorkRequests operation
type ListApmDomainWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WorkRequest instances
Items []WorkRequest `presentIn:"body"`
// 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"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListApmDomainWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListApmDomainWorkRequestsResponse) String() string
ListApmDomainsLifecycleStateEnum Enum with underlying type: string
type ListApmDomainsLifecycleStateEnum string
Set of constants representing the allowable values for ListApmDomainsLifecycleStateEnum
const (
ListApmDomainsLifecycleStateCreating ListApmDomainsLifecycleStateEnum = "CREATING"
ListApmDomainsLifecycleStateUpdating ListApmDomainsLifecycleStateEnum = "UPDATING"
ListApmDomainsLifecycleStateActive ListApmDomainsLifecycleStateEnum = "ACTIVE"
ListApmDomainsLifecycleStateDeleting ListApmDomainsLifecycleStateEnum = "DELETING"
ListApmDomainsLifecycleStateDeleted ListApmDomainsLifecycleStateEnum = "DELETED"
ListApmDomainsLifecycleStateFailed ListApmDomainsLifecycleStateEnum = "FAILED"
)
func GetListApmDomainsLifecycleStateEnumValues() []ListApmDomainsLifecycleStateEnum
GetListApmDomainsLifecycleStateEnumValues Enumerates the set of values for ListApmDomainsLifecycleStateEnum
func GetMappingListApmDomainsLifecycleStateEnum(val string) (ListApmDomainsLifecycleStateEnum, bool)
GetMappingListApmDomainsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListApmDomainsRequest wrapper for the ListApmDomains operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/ListApmDomains.go.html to see an example of how to use ListApmDomainsRequest.
type ListApmDomainsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match the given life-cycle state.
LifecycleState ListApmDomainsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListApmDomainsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified, timeCreated is default.
SortBy ListApmDomainsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
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 ListApmDomainsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListApmDomainsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListApmDomainsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListApmDomainsRequest) String() string
func (request ListApmDomainsRequest) 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
ListApmDomainsResponse wrapper for the ListApmDomains operation
type ListApmDomainsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []ApmDomainSummary instances
Items []ApmDomainSummary `presentIn:"body"`
// 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"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListApmDomainsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListApmDomainsResponse) String() string
ListApmDomainsSortByEnum Enum with underlying type: string
type ListApmDomainsSortByEnum string
Set of constants representing the allowable values for ListApmDomainsSortByEnum
const (
ListApmDomainsSortByTimecreated ListApmDomainsSortByEnum = "timeCreated"
ListApmDomainsSortByDisplayname ListApmDomainsSortByEnum = "displayName"
)
func GetListApmDomainsSortByEnumValues() []ListApmDomainsSortByEnum
GetListApmDomainsSortByEnumValues Enumerates the set of values for ListApmDomainsSortByEnum
func GetMappingListApmDomainsSortByEnum(val string) (ListApmDomainsSortByEnum, bool)
GetMappingListApmDomainsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListApmDomainsSortOrderEnum Enum with underlying type: string
type ListApmDomainsSortOrderEnum string
Set of constants representing the allowable values for ListApmDomainsSortOrderEnum
const (
ListApmDomainsSortOrderAsc ListApmDomainsSortOrderEnum = "ASC"
ListApmDomainsSortOrderDesc ListApmDomainsSortOrderEnum = "DESC"
)
func GetListApmDomainsSortOrderEnumValues() []ListApmDomainsSortOrderEnum
GetListApmDomainsSortOrderEnumValues Enumerates the set of values for ListApmDomainsSortOrderEnum
func GetMappingListApmDomainsSortOrderEnum(val string) (ListApmDomainsSortOrderEnum, bool)
GetMappingListApmDomainsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDataKeysDataKeyTypeEnum Enum with underlying type: string
type ListDataKeysDataKeyTypeEnum string
Set of constants representing the allowable values for ListDataKeysDataKeyTypeEnum
const (
ListDataKeysDataKeyTypePrivate ListDataKeysDataKeyTypeEnum = "PRIVATE"
ListDataKeysDataKeyTypePublic ListDataKeysDataKeyTypeEnum = "PUBLIC"
)
func GetListDataKeysDataKeyTypeEnumValues() []ListDataKeysDataKeyTypeEnum
GetListDataKeysDataKeyTypeEnumValues Enumerates the set of values for ListDataKeysDataKeyTypeEnum
func GetMappingListDataKeysDataKeyTypeEnum(val string) (ListDataKeysDataKeyTypeEnum, bool)
GetMappingListDataKeysDataKeyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListDataKeysRequest wrapper for the ListDataKeys operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/ListDataKeys.go.html to see an example of how to use ListDataKeysRequest.
type ListDataKeysRequest struct {
// The OCID of the APM domain.
ApmDomainId *string `mandatory:"true" contributesTo:"path" name:"apmDomainId"`
// Data key type.
DataKeyType ListDataKeysDataKeyTypeEnum `mandatory:"false" contributesTo:"query" name:"dataKeyType" omitEmpty:"true"`
// The client request ID for tracing.
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 ListDataKeysRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDataKeysRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDataKeysRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDataKeysRequest) String() string
func (request ListDataKeysRequest) 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
ListDataKeysResponse wrapper for the ListDataKeys operation
type ListDataKeysResponse struct {
// The underlying http response
RawResponse *http.Response
// The []DataKeySummary instance
Items []DataKeySummary `presentIn:"body"`
// 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 ListDataKeysResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDataKeysResponse) String() string
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// 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 pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// 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 []WorkRequestLogEntry instances
Items []WorkRequestLogEntry `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// 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
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WorkRequest instances
Items []WorkRequest `presentIn:"body"`
// 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"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypesEnum Enum with underlying type: string
type OperationTypesEnum string
Set of constants representing the allowable values for OperationTypesEnum
const (
OperationTypesCreateApmDomain OperationTypesEnum = "CREATE_APM_DOMAIN"
OperationTypesUpdateApmDomain OperationTypesEnum = "UPDATE_APM_DOMAIN"
OperationTypesDeleteApmDomain OperationTypesEnum = "DELETE_APM_DOMAIN"
OperationTypesGenerateDataKeys OperationTypesEnum = "GENERATE_DATA_KEYS"
OperationTypesRemoveDataKeys OperationTypesEnum = "REMOVE_DATA_KEYS"
)
func GetMappingOperationTypesEnum(val string) (OperationTypesEnum, bool)
GetMappingOperationTypesEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypesEnumValues() []OperationTypesEnum
GetOperationTypesEnumValues Enumerates the set of values for OperationTypesEnum
RemoveDataKeyDetails Details of the Data Key to be removed.
type RemoveDataKeyDetails struct {
// Name of the Data Key. The name uniquely identifies a Data Key within an APM domain.
Name *string `mandatory:"true" json:"name"`
}
func (m RemoveDataKeyDetails) String() string
func (m RemoveDataKeyDetails) 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
RemoveDataKeysRequest wrapper for the RemoveDataKeys operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/RemoveDataKeys.go.html to see an example of how to use RemoveDataKeysRequest.
type RemoveDataKeysRequest struct {
// The OCID of the APM domain.
ApmDomainId *string `mandatory:"true" contributesTo:"path" name:"apmDomainId"`
// List of Data Keys to be removed.
RemoveDataKeysListDetails []RemoveDataKeyDetails `contributesTo:"body"`
// For optimistic concurrency control. 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"`
// The client request ID for tracing.
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 RemoveDataKeysRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveDataKeysRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveDataKeysRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveDataKeysRequest) String() string
func (request RemoveDataKeysRequest) 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
RemoveDataKeysResponse wrapper for the RemoveDataKeys operation
type RemoveDataKeysResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 RemoveDataKeysResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveDataKeysResponse) String() string
SortOrdersEnum Enum with underlying type: string
type SortOrdersEnum string
Set of constants representing the allowable values for SortOrdersEnum
const (
SortOrdersAsc SortOrdersEnum = "ASC"
SortOrdersDesc SortOrdersEnum = "DESC"
)
func GetMappingSortOrdersEnum(val string) (SortOrdersEnum, bool)
GetMappingSortOrdersEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrdersEnumValues() []SortOrdersEnum
GetSortOrdersEnumValues Enumerates the set of values for SortOrdersEnum
UpdateApmDomainDetails The information that can be updated by update APM domain operation.
type UpdateApmDomainDetails struct {
// Display name of the APM domain.
DisplayName *string `mandatory:"false" json:"displayName"`
// Description of the APM domain.
Description *string `mandatory:"false" json:"description"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateApmDomainDetails) String() string
func (m UpdateApmDomainDetails) 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
UpdateApmDomainRequest wrapper for the UpdateApmDomain operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmcontrolplane/UpdateApmDomain.go.html to see an example of how to use UpdateApmDomainRequest.
type UpdateApmDomainRequest struct {
// The OCID of the APM domain.
ApmDomainId *string `mandatory:"true" contributesTo:"path" name:"apmDomainId"`
// The information to be updated for the APM domain.
UpdateApmDomainDetails `contributesTo:"body"`
// For optimistic concurrency control. 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"`
// The client request ID for tracing.
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 UpdateApmDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateApmDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateApmDomainRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateApmDomainRequest) String() string
func (request UpdateApmDomainRequest) 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
UpdateApmDomainResponse wrapper for the UpdateApmDomain operation
type UpdateApmDomainResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 UpdateApmDomainResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateApmDomainResponse) String() string
WorkRequest A description of work request.
type WorkRequest struct {
// The type of the work request.
OperationType OperationTypesEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The ID of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by the work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
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
WorkRequestError An error encountered while executing a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occurred. Error codes are listed at
// API Errors (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm)
Code *string `mandatory:"true" json:"code"`
// A human readable description of the issue encountered.
Message *string `mandatory:"true" json:"message"`
// The time the error occurred, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
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
WorkRequestLogEntry A log message from the execution of a work request.
type WorkRequestLogEntry struct {
// Human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The time the error occurred, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) 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
WorkRequestResource The details of the resource that the work request affects.
type WorkRequestResource struct {
// The resource type the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the work tracked in the work request.
// A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
// work is complete for that resource at which point it will transition to CREATED, UPDATED,
// or DELETED, respectively.
ActionType ActionTypesEnum `mandatory:"true" json:"actionType"`
// The identifier of the resource the work request affects.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that the user can do a GET on to access the resource metadata.
EntityUri *string `mandatory:"false" json:"entityUri"`
}
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