func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetBaseTagDefinitionValidatorValidatorTypeEnumStringValues() []string
GetBaseTagDefinitionValidatorValidatorTypeEnumStringValues Enumerates the set of values in String for BaseTagDefinitionValidatorValidatorTypeEnum
func GetCreationOptionEnumStringValues() []string
GetCreationOptionEnumStringValues Enumerates the set of values in String for CreationOptionEnum
func GetGovernanceRuleLifecycleStateEnumStringValues() []string
GetGovernanceRuleLifecycleStateEnumStringValues Enumerates the set of values in String for GovernanceRuleLifecycleStateEnum
func GetGovernanceRuleTypeEnumStringValues() []string
GetGovernanceRuleTypeEnumStringValues Enumerates the set of values in String for GovernanceRuleTypeEnum
func GetInclusionCriterionLifecycleStateEnumStringValues() []string
GetInclusionCriterionLifecycleStateEnumStringValues Enumerates the set of values in String for InclusionCriterionLifecycleStateEnum
func GetInclusionCriterionTypeEnumStringValues() []string
GetInclusionCriterionTypeEnumStringValues Enumerates the set of values in String for InclusionCriterionTypeEnum
func GetListEnforcedGovernanceRulesGovernanceRuleTypeEnumStringValues() []string
GetListEnforcedGovernanceRulesGovernanceRuleTypeEnumStringValues Enumerates the set of values in String for ListEnforcedGovernanceRulesGovernanceRuleTypeEnum
func GetListEnforcedGovernanceRulesSortByEnumStringValues() []string
GetListEnforcedGovernanceRulesSortByEnumStringValues Enumerates the set of values in String for ListEnforcedGovernanceRulesSortByEnum
func GetListEnforcedGovernanceRulesSortOrderEnumStringValues() []string
GetListEnforcedGovernanceRulesSortOrderEnumStringValues Enumerates the set of values in String for ListEnforcedGovernanceRulesSortOrderEnum
func GetListGovernanceRulesGovernanceRuleTypeEnumStringValues() []string
GetListGovernanceRulesGovernanceRuleTypeEnumStringValues Enumerates the set of values in String for ListGovernanceRulesGovernanceRuleTypeEnum
func GetListGovernanceRulesLifecycleStateEnumStringValues() []string
GetListGovernanceRulesLifecycleStateEnumStringValues Enumerates the set of values in String for ListGovernanceRulesLifecycleStateEnum
func GetListGovernanceRulesSortByEnumStringValues() []string
GetListGovernanceRulesSortByEnumStringValues Enumerates the set of values in String for ListGovernanceRulesSortByEnum
func GetListGovernanceRulesSortOrderEnumStringValues() []string
GetListGovernanceRulesSortOrderEnumStringValues Enumerates the set of values in String for ListGovernanceRulesSortOrderEnum
func GetListInclusionCriteriaSortByEnumStringValues() []string
GetListInclusionCriteriaSortByEnumStringValues Enumerates the set of values in String for ListInclusionCriteriaSortByEnum
func GetListInclusionCriteriaSortOrderEnumStringValues() []string
GetListInclusionCriteriaSortOrderEnumStringValues Enumerates the set of values in String for ListInclusionCriteriaSortOrderEnum
func GetListTenancyAttachmentsSortByEnumStringValues() []string
GetListTenancyAttachmentsSortByEnumStringValues Enumerates the set of values in String for ListTenancyAttachmentsSortByEnum
func GetListTenancyAttachmentsSortOrderEnumStringValues() []string
GetListTenancyAttachmentsSortOrderEnumStringValues Enumerates the set of values in String for ListTenancyAttachmentsSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
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 GetListWorkRequestsStatusEnumStringValues() []string
GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetTenancyAttachmentLifecycleStateEnumStringValues() []string
GetTenancyAttachmentLifecycleStateEnumStringValues Enumerates the set of values in String for TenancyAttachmentLifecycleStateEnum
func GetWorkRequestResourceMetadataKeyEnumStringValues() []string
GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeRelated ActionTypeEnum = "RELATED"
ActionTypeFailed ActionTypeEnum = "FAILED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AllowedRegionsTemplate Template for governance rules of type allowed regions (ALLOWED_REGIONS).
type AllowedRegionsTemplate struct {
// Display name of the allowed region resource.
DisplayName *string `mandatory:"true" json:"displayName"`
// List of allowed regions.
Regions []string `mandatory:"true" json:"regions"`
// Description of the allowed region resource.
Description *string `mandatory:"false" json:"description"`
}
func (m AllowedRegionsTemplate) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AllowedRegionsTemplate) String() string
func (m AllowedRegionsTemplate) 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
Association Association represents the basis on which the governance rule will be applied to the opted-in child tenancies.
type Association interface {
}
BaseTagDefinitionValidator Validates a definedTag value. Each validator performs validation steps in addition to the standard validation for definedTag values. For more information, see Limits on Tags (https://docs.cloud.oracle.com/Content/Tagging/Concepts/taggingoverview.htm#limits). If you define a validator after a value has been set for a defined tag, then any updates that attempt to change the value must pass the additional validation defined by the current rule. Previously set values (even those that would fail the current validation) are not updated. You can still update other attributes to resources that contain a non-valid defined tag. To clear the validator call UpdateTag with DefaultTagDefinitionValidator (https://docs.cloud.oracle.com/api/#/en/identity/latest/datatypes/DefaultTagDefinitionValidator).
type BaseTagDefinitionValidator interface {
}
BaseTagDefinitionValidatorValidatorTypeEnum Enum with underlying type: string
type BaseTagDefinitionValidatorValidatorTypeEnum string
Set of constants representing the allowable values for BaseTagDefinitionValidatorValidatorTypeEnum
const (
BaseTagDefinitionValidatorValidatorTypeEnumvalue BaseTagDefinitionValidatorValidatorTypeEnum = "ENUM"
BaseTagDefinitionValidatorValidatorTypeDefault BaseTagDefinitionValidatorValidatorTypeEnum = "DEFAULT"
)
func GetBaseTagDefinitionValidatorValidatorTypeEnumValues() []BaseTagDefinitionValidatorValidatorTypeEnum
GetBaseTagDefinitionValidatorValidatorTypeEnumValues Enumerates the set of values for BaseTagDefinitionValidatorValidatorTypeEnum
func GetMappingBaseTagDefinitionValidatorValidatorTypeEnum(val string) (BaseTagDefinitionValidatorValidatorTypeEnum, bool)
GetMappingBaseTagDefinitionValidatorValidatorTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CancelWorkRequestRequest wrapper for the CancelWorkRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequestRequest.
type CancelWorkRequestRequest struct {
// The ID of the asynchronous 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"`
// 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 CancelWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelWorkRequestRequest) String() string
func (request CancelWorkRequestRequest) 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
CancelWorkRequestResponse wrapper for the CancelWorkRequest operation
type CancelWorkRequestResponse 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 CancelWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelWorkRequestResponse) String() string
CreateGovernanceRuleDetails Request object for CreateGovernanceRule operation.
type CreateGovernanceRuleDetails struct {
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the root compartment containing the governance rule.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Display name of the governance rule.
DisplayName *string `mandatory:"true" json:"displayName"`
// Type of the governance rule, can be one of QUOTA, TAG, ALLOWED_REGIONS.
// Example: `QUOTA`
Type GovernanceRuleTypeEnum `mandatory:"true" json:"type"`
// The type of option used to create the governance rule, could be one of TEMPLATE or CLONE.
// Example: `TEMPLATE`
CreationOption CreationOptionEnum `mandatory:"true" json:"creationOption"`
Template Template `mandatory:"true" json:"template"`
// Description of the governance rule.
Description *string `mandatory:"false" json:"description"`
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the resource, which was used as a template to create this governance rule.
RelatedResourceId *string `mandatory:"false" json:"relatedResourceId"`
// 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 CreateGovernanceRuleDetails) String() string
func (m *CreateGovernanceRuleDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateGovernanceRuleDetails) 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
CreateGovernanceRuleRequest wrapper for the CreateGovernanceRule operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/CreateGovernanceRule.go.html to see an example of how to use CreateGovernanceRuleRequest.
type CreateGovernanceRuleRequest struct {
// Details to create a new governance rule.
CreateGovernanceRuleDetails `contributesTo:"body"`
// 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
// 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 CreateGovernanceRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateGovernanceRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateGovernanceRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateGovernanceRuleRequest) String() string
func (request CreateGovernanceRuleRequest) 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
CreateGovernanceRuleResponse wrapper for the CreateGovernanceRule operation
type CreateGovernanceRuleResponse struct {
// The underlying http response
RawResponse *http.Response
// The GovernanceRule instance
GovernanceRule `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
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"`
// The URI of the request.
Location *string `presentIn:"header" name:"location"`
}
func (response CreateGovernanceRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateGovernanceRuleResponse) String() string
CreateInclusionCriterionDetails Request object for Createinclusion criterion operation.
type CreateInclusionCriterionDetails struct {
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the governance rule. Every inclusion criterion is associated with a governance rule.
GovernanceRuleId *string `mandatory:"true" json:"governanceRuleId"`
// Type of inclusion criterion - TENANCY, ALL or TAG. We support TENANCY and ALL for now.
Type InclusionCriterionTypeEnum `mandatory:"true" json:"type"`
Association Association `mandatory:"false" json:"association"`
}
func (m CreateInclusionCriterionDetails) String() string
func (m *CreateInclusionCriterionDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateInclusionCriterionDetails) 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
CreateInclusionCriterionRequest wrapper for the CreateInclusionCriterion operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/CreateInclusionCriterion.go.html to see an example of how to use CreateInclusionCriterionRequest.
type CreateInclusionCriterionRequest struct {
// Details to create a new inclusion criterion.
CreateInclusionCriterionDetails `contributesTo:"body"`
// 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
// 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 CreateInclusionCriterionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateInclusionCriterionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateInclusionCriterionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateInclusionCriterionRequest) String() string
func (request CreateInclusionCriterionRequest) 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
CreateInclusionCriterionResponse wrapper for the CreateInclusionCriterion operation
type CreateInclusionCriterionResponse struct {
// The underlying http response
RawResponse *http.Response
// The InclusionCriterion instance
InclusionCriterion `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
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"`
// The URI of the request.
Location *string `presentIn:"header" name:"location"`
}
func (response CreateInclusionCriterionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateInclusionCriterionResponse) String() string
CreationOptionEnum Enum with underlying type: string
type CreationOptionEnum string
Set of constants representing the allowable values for CreationOptionEnum
const (
CreationOptionTemplate CreationOptionEnum = "TEMPLATE"
CreationOptionClone CreationOptionEnum = "CLONE"
)
func GetCreationOptionEnumValues() []CreationOptionEnum
GetCreationOptionEnumValues Enumerates the set of values for CreationOptionEnum
func GetMappingCreationOptionEnum(val string) (CreationOptionEnum, bool)
GetMappingCreationOptionEnum performs case Insensitive comparison on enum value and return the desired enum
DefaultTagDefinitionValidator Use this validator to clear any existing validator on the tag key definition with the UpdateTag operation. Using this `validatorType` is the same as not setting any value on the validator field. The resultant value for `validatorType` returned in the response body is `null`.
type DefaultTagDefinitionValidator struct {
}
func (m DefaultTagDefinitionValidator) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DefaultTagDefinitionValidator) String() string
func (m DefaultTagDefinitionValidator) 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
DeleteGovernanceRuleRequest wrapper for the DeleteGovernanceRule operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/DeleteGovernanceRule.go.html to see an example of how to use DeleteGovernanceRuleRequest.
type DeleteGovernanceRuleRequest struct {
// Unique governance rule identifier.
GovernanceRuleId *string `mandatory:"true" contributesTo:"path" name:"governanceRuleId"`
// 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"`
// 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 DeleteGovernanceRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteGovernanceRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteGovernanceRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteGovernanceRuleRequest) String() string
func (request DeleteGovernanceRuleRequest) 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
DeleteGovernanceRuleResponse wrapper for the DeleteGovernanceRule operation
type DeleteGovernanceRuleResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
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 DeleteGovernanceRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteGovernanceRuleResponse) String() string
DeleteInclusionCriterionRequest wrapper for the DeleteInclusionCriterion operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/DeleteInclusionCriterion.go.html to see an example of how to use DeleteInclusionCriterionRequest.
type DeleteInclusionCriterionRequest struct {
// Unique inclusion criterion identifier.
InclusionCriterionId *string `mandatory:"true" contributesTo:"path" name:"inclusionCriterionId"`
// 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"`
// 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 DeleteInclusionCriterionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteInclusionCriterionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteInclusionCriterionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteInclusionCriterionRequest) String() string
func (request DeleteInclusionCriterionRequest) 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
DeleteInclusionCriterionResponse wrapper for the DeleteInclusionCriterion operation
type DeleteInclusionCriterionResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
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 DeleteInclusionCriterionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteInclusionCriterionResponse) String() string
EnforcedGovernanceRule Represents the governance rule shown to the child which is a subset of governance rule resource in parent tenancy.
type EnforcedGovernanceRule struct {
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the enforced governance rule.
Id *string `mandatory:"true" json:"id"`
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the child's root compartment to which the governance rule is attached.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Display name of the governance rule.
GovernanceRuleDisplayName *string `mandatory:"true" json:"governanceRuleDisplayName"`
// Type of the governance rule, can be one of QUOTA, TAG, ALLOWED_REGIONS.
// Example: `QUOTA`
Type GovernanceRuleTypeEnum `mandatory:"true" json:"type"`
Template Template `mandatory:"true" json:"template"`
// The current state of the governance rule.
LifecycleState GovernanceRuleLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Date and time the governance rule was created. An RFC3339 formatted datetime string.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Date and time the governance rule was updated. An RFC3339 formatted datetime string.
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
}
func (m EnforcedGovernanceRule) String() string
func (m *EnforcedGovernanceRule) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m EnforcedGovernanceRule) 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
EnforcedGovernanceRuleCollection Results of an enforced governance rule search. Contains EnforcedGovernanceRuleSummary items.
type EnforcedGovernanceRuleCollection struct {
// List of EnforcedGovernanceRuleSummary objects.
Items []EnforcedGovernanceRuleSummary `mandatory:"true" json:"items"`
}
func (m EnforcedGovernanceRuleCollection) String() string
func (m EnforcedGovernanceRuleCollection) 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
EnforcedGovernanceRuleSummary A summary of the enforced governance rule.
type EnforcedGovernanceRuleSummary struct {
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the enforced governance rule.
Id *string `mandatory:"true" json:"id"`
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the child's root compartment to which the governance rule is attached.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Display name of the governance rule.
GovernanceRuleDisplayName *string `mandatory:"true" json:"governanceRuleDisplayName"`
// Type of the governance rule, can be one of QUOTA, TAG, ALLOWED_REGIONS.
// Example: `QUOTA`
Type GovernanceRuleTypeEnum `mandatory:"true" json:"type"`
// The current state of the governance rule.
LifecycleState GovernanceRuleLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Date and time the governance rule was created. An RFC3339 formatted datetime string.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Date and time the governance rule was updated. An RFC3339 formatted datetime string.
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
}
func (m EnforcedGovernanceRuleSummary) String() string
func (m EnforcedGovernanceRuleSummary) 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
EnumTagDefinitionValidator Used to validate the value set for a defined tag and contains the list of allowable `values`. You must specify at least one valid value in the `values` array. You can't have blank or or empty strings (`""`). Duplicate values are not allowed.
type EnumTagDefinitionValidator struct {
// The list of allowed values for a definedTag value.
Values []string `mandatory:"false" json:"values"`
}
func (m EnumTagDefinitionValidator) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m EnumTagDefinitionValidator) String() string
func (m EnumTagDefinitionValidator) 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
GetEnforcedGovernanceRuleRequest wrapper for the GetEnforcedGovernanceRule operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/GetEnforcedGovernanceRule.go.html to see an example of how to use GetEnforcedGovernanceRuleRequest.
type GetEnforcedGovernanceRuleRequest struct {
// Unique enforced governance rule identifier.
EnforcedGovernanceRuleId *string `mandatory:"true" contributesTo:"path" name:"enforcedGovernanceRuleId"`
// 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 GetEnforcedGovernanceRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetEnforcedGovernanceRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetEnforcedGovernanceRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetEnforcedGovernanceRuleRequest) String() string
func (request GetEnforcedGovernanceRuleRequest) 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
GetEnforcedGovernanceRuleResponse wrapper for the GetEnforcedGovernanceRule operation
type GetEnforcedGovernanceRuleResponse struct {
// The underlying http response
RawResponse *http.Response
// The EnforcedGovernanceRule instance
EnforcedGovernanceRule `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 GetEnforcedGovernanceRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetEnforcedGovernanceRuleResponse) String() string
GetGovernanceRuleRequest wrapper for the GetGovernanceRule operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/GetGovernanceRule.go.html to see an example of how to use GetGovernanceRuleRequest.
type GetGovernanceRuleRequest struct {
// Unique governance rule identifier.
GovernanceRuleId *string `mandatory:"true" contributesTo:"path" name:"governanceRuleId"`
// 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 GetGovernanceRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetGovernanceRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetGovernanceRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetGovernanceRuleRequest) String() string
func (request GetGovernanceRuleRequest) 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
GetGovernanceRuleResponse wrapper for the GetGovernanceRule operation
type GetGovernanceRuleResponse struct {
// The underlying http response
RawResponse *http.Response
// The GovernanceRule instance
GovernanceRule `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 GetGovernanceRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetGovernanceRuleResponse) String() string
GetInclusionCriterionRequest wrapper for the GetInclusionCriterion operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/GetInclusionCriterion.go.html to see an example of how to use GetInclusionCriterionRequest.
type GetInclusionCriterionRequest struct {
// Unique inclusion criterion identifier.
InclusionCriterionId *string `mandatory:"true" contributesTo:"path" name:"inclusionCriterionId"`
// 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 GetInclusionCriterionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetInclusionCriterionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetInclusionCriterionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetInclusionCriterionRequest) String() string
func (request GetInclusionCriterionRequest) 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
GetInclusionCriterionResponse wrapper for the GetInclusionCriterion operation
type GetInclusionCriterionResponse struct {
// The underlying http response
RawResponse *http.Response
// The InclusionCriterion instance
InclusionCriterion `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 GetInclusionCriterionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetInclusionCriterionResponse) String() string
GetTenancyAttachmentRequest wrapper for the GetTenancyAttachment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/GetTenancyAttachment.go.html to see an example of how to use GetTenancyAttachmentRequest.
type GetTenancyAttachmentRequest struct {
// Unique tenancy attachment identifier.
TenancyAttachmentId *string `mandatory:"true" contributesTo:"path" name:"tenancyAttachmentId"`
// 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 GetTenancyAttachmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetTenancyAttachmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetTenancyAttachmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetTenancyAttachmentRequest) String() string
func (request GetTenancyAttachmentRequest) 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
GetTenancyAttachmentResponse wrapper for the GetTenancyAttachment operation
type GetTenancyAttachmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The TenancyAttachment instance
TenancyAttachment `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 GetTenancyAttachmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetTenancyAttachmentResponse) 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/governancerulescontrolplane/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 *int `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
GovernanceRule Represents a rule in parent tenancy which governs resources in child tenancies.
type GovernanceRule struct {
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the governance rule.
Id *string `mandatory:"true" json:"id"`
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the root compartment containing the governance rule.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Display name of the governance rule.
DisplayName *string `mandatory:"true" json:"displayName"`
// Type of the governance rule, can be one of QUOTA, TAG, ALLOWED_REGIONS.
// Example: `QUOTA`
Type GovernanceRuleTypeEnum `mandatory:"true" json:"type"`
// The type of option used to create the governance rule, could be one of TEMPLATE or CLONE.
// Example: `TEMPLATE`
CreationOption CreationOptionEnum `mandatory:"true" json:"creationOption"`
Template Template `mandatory:"true" json:"template"`
// Date and time the governance rule was created. An RFC3339 formatted datetime string.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Date and time the governance rule was updated. An RFC3339 formatted datetime string.
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the governance rule.
LifecycleState GovernanceRuleLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// 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:"true" 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:"true" json:"definedTags"`
// Description of the governance rule.
Description *string `mandatory:"false" json:"description"`
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the resource, which was used as a template to create this governance rule.
RelatedResourceId *string `mandatory:"false" json:"relatedResourceId"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m GovernanceRule) String() string
func (m *GovernanceRule) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m GovernanceRule) 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
GovernanceRuleClient a client for GovernanceRule
type GovernanceRuleClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewGovernanceRuleClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client GovernanceRuleClient, err error)
NewGovernanceRuleClientWithConfigurationProvider Creates a new default GovernanceRule client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewGovernanceRuleClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client GovernanceRuleClient, err error)
NewGovernanceRuleClientWithOboToken Creates a new default GovernanceRule 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 *GovernanceRuleClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client GovernanceRuleClient) CreateGovernanceRule(ctx context.Context, request CreateGovernanceRuleRequest) (response CreateGovernanceRuleResponse, err error)
CreateGovernanceRule Create governance rule in the root compartment only. Either relatedResourceId or template must be supplied.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/CreateGovernanceRule.go.html to see an example of how to use CreateGovernanceRule API.
func (client GovernanceRuleClient) CreateInclusionCriterion(ctx context.Context, request CreateInclusionCriterionRequest) (response CreateInclusionCriterionResponse, err error)
CreateInclusionCriterion Create inclusion criterion of type tenancy or tag for the governance rule.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/CreateInclusionCriterion.go.html to see an example of how to use CreateInclusionCriterion API.
func (client GovernanceRuleClient) DeleteGovernanceRule(ctx context.Context, request DeleteGovernanceRuleRequest) (response DeleteGovernanceRuleResponse, err error)
DeleteGovernanceRule Delete the specified governance rule.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/DeleteGovernanceRule.go.html to see an example of how to use DeleteGovernanceRule API.
func (client GovernanceRuleClient) DeleteInclusionCriterion(ctx context.Context, request DeleteInclusionCriterionRequest) (response DeleteInclusionCriterionResponse, err error)
DeleteInclusionCriterion Delete the specified inclusion criterion.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/DeleteInclusionCriterion.go.html to see an example of how to use DeleteInclusionCriterion API.
func (client GovernanceRuleClient) GetEnforcedGovernanceRule(ctx context.Context, request GetEnforcedGovernanceRuleRequest) (response GetEnforcedGovernanceRuleResponse, err error)
GetEnforcedGovernanceRule Get the specified enforced governance rule's information.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/GetEnforcedGovernanceRule.go.html to see an example of how to use GetEnforcedGovernanceRule API.
func (client GovernanceRuleClient) GetGovernanceRule(ctx context.Context, request GetGovernanceRuleRequest) (response GetGovernanceRuleResponse, err error)
GetGovernanceRule Get the specified governance rule's information.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/GetGovernanceRule.go.html to see an example of how to use GetGovernanceRule API.
func (client GovernanceRuleClient) GetInclusionCriterion(ctx context.Context, request GetInclusionCriterionRequest) (response GetInclusionCriterionResponse, err error)
GetInclusionCriterion Get the specified inclusion criterion's information.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/GetInclusionCriterion.go.html to see an example of how to use GetInclusionCriterion API.
func (client GovernanceRuleClient) GetTenancyAttachment(ctx context.Context, request GetTenancyAttachmentRequest) (response GetTenancyAttachmentResponse, err error)
GetTenancyAttachment Get the specified tenancy attachment's information.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/GetTenancyAttachment.go.html to see an example of how to use GetTenancyAttachment API.
func (client GovernanceRuleClient) ListEnforcedGovernanceRules(ctx context.Context, request ListEnforcedGovernanceRulesRequest) (response ListEnforcedGovernanceRulesResponse, err error)
ListEnforcedGovernanceRules List enforced governance rules. Either compartment id or enforced governance rule id must be supplied. An optional governance rule type or a display name can also be supplied.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/ListEnforcedGovernanceRules.go.html to see an example of how to use ListEnforcedGovernanceRules API.
func (client GovernanceRuleClient) ListGovernanceRules(ctx context.Context, request ListGovernanceRulesRequest) (response ListGovernanceRulesResponse, err error)
ListGovernanceRules List governance rules. Either compartment id or governance rule id must be supplied. An optional lifecycle state, display name or a governance rule type can also be supplied.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/ListGovernanceRules.go.html to see an example of how to use ListGovernanceRules API.
func (client GovernanceRuleClient) ListInclusionCriteria(ctx context.Context, request ListInclusionCriteriaRequest) (response ListInclusionCriteriaResponse, err error)
ListInclusionCriteria List inclusion criteria associated with a governance rule. Governance rule id must be supplied. An optional inclusion criterion id or a lifecycle state can also be supplied.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/ListInclusionCriteria.go.html to see an example of how to use ListInclusionCriteria API.
func (client GovernanceRuleClient) ListTenancyAttachments(ctx context.Context, request ListTenancyAttachmentsRequest) (response ListTenancyAttachmentsResponse, err error)
ListTenancyAttachments List tenancy attachments. Either compartment id, governance rule id or tenancy attachment id must be supplied. An optional lifecycle state or a child tenancy id can also be supplied.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/ListTenancyAttachments.go.html to see an example of how to use ListTenancyAttachments API.
func (client GovernanceRuleClient) RetryGovernanceRule(ctx context.Context, request RetryGovernanceRuleRequest) (response RetryGovernanceRuleResponse, err error)
RetryGovernanceRule Retry the creation of the specified governance rule. Used by the tenancy admins when all the workflow retries have exhausted. When provided, If-Match is checked against ETag values of the resource.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/RetryGovernanceRule.go.html to see an example of how to use RetryGovernanceRule API.
func (client GovernanceRuleClient) RetryTenancyAttachment(ctx context.Context, request RetryTenancyAttachmentRequest) (response RetryTenancyAttachmentResponse, err error)
RetryTenancyAttachment Retry governance rule application for the specified tenancy attachment id. Used by the tenancy admins when all the workflow retries have exhausted.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/RetryTenancyAttachment.go.html to see an example of how to use RetryTenancyAttachment API.
func (client *GovernanceRuleClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client GovernanceRuleClient) UpdateGovernanceRule(ctx context.Context, request UpdateGovernanceRuleRequest) (response UpdateGovernanceRuleResponse, err error)
UpdateGovernanceRule Update the specified governance rule.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/UpdateGovernanceRule.go.html to see an example of how to use UpdateGovernanceRule API.
GovernanceRuleCollection Results of a governance rule search. Contains GovernanceRuleSummary items.
type GovernanceRuleCollection struct {
// List of GovernanceRuleSummary objects.
Items []GovernanceRuleSummary `mandatory:"true" json:"items"`
}
func (m GovernanceRuleCollection) String() string
func (m GovernanceRuleCollection) 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
GovernanceRuleLifecycleStateEnum Enum with underlying type: string
type GovernanceRuleLifecycleStateEnum string
Set of constants representing the allowable values for GovernanceRuleLifecycleStateEnum
const (
GovernanceRuleLifecycleStateActive GovernanceRuleLifecycleStateEnum = "ACTIVE"
GovernanceRuleLifecycleStateDeleted GovernanceRuleLifecycleStateEnum = "DELETED"
)
func GetGovernanceRuleLifecycleStateEnumValues() []GovernanceRuleLifecycleStateEnum
GetGovernanceRuleLifecycleStateEnumValues Enumerates the set of values for GovernanceRuleLifecycleStateEnum
func GetMappingGovernanceRuleLifecycleStateEnum(val string) (GovernanceRuleLifecycleStateEnum, bool)
GetMappingGovernanceRuleLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
GovernanceRuleSummary A summary of the governance rule.
type GovernanceRuleSummary struct {
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the governance rule.
Id *string `mandatory:"true" json:"id"`
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the root compartment containing the governance rule.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Display name of the governance rule.
DisplayName *string `mandatory:"true" json:"displayName"`
// Type of the governance rule, can be one of QUOTA, TAG, ALLOWED_REGIONS.
// Example: `QUOTA`
Type GovernanceRuleTypeEnum `mandatory:"true" json:"type"`
// The type of option used to create the governance rule, could be one of TEMPLATE or CLONE.
// Example: `TEMPLATE`
CreationOption CreationOptionEnum `mandatory:"true" json:"creationOption"`
// Date and time the governance rule was created. An RFC3339 formatted datetime string.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Date and time the governance rule was updated. An RFC3339 formatted datetime string.
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the governance rule.
LifecycleState GovernanceRuleLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// 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:"true" 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:"true" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m GovernanceRuleSummary) String() string
func (m GovernanceRuleSummary) 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
GovernanceRuleTypeEnum Enum with underlying type: string
type GovernanceRuleTypeEnum string
Set of constants representing the allowable values for GovernanceRuleTypeEnum
const (
GovernanceRuleTypeQuota GovernanceRuleTypeEnum = "QUOTA"
GovernanceRuleTypeTag GovernanceRuleTypeEnum = "TAG"
GovernanceRuleTypeAllowedRegions GovernanceRuleTypeEnum = "ALLOWED_REGIONS"
)
func GetGovernanceRuleTypeEnumValues() []GovernanceRuleTypeEnum
GetGovernanceRuleTypeEnumValues Enumerates the set of values for GovernanceRuleTypeEnum
func GetMappingGovernanceRuleTypeEnum(val string) (GovernanceRuleTypeEnum, bool)
GetMappingGovernanceRuleTypeEnum performs case Insensitive comparison on enum value and return the desired enum
InclusionCriterion Represents the criterion for the inclusion of the child tenancies under a governance rule. This can be either TENANCY or TAG.
type InclusionCriterion struct {
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the inclusion criterion.
Id *string `mandatory:"true" json:"id"`
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the governance rule. Every inclusion criterion is associated with a governance rule.
GovernanceRuleId *string `mandatory:"true" json:"governanceRuleId"`
// Type of inclusion criterion - TENANCY, ALL or TAG. We support TENANCY and ALL for now.
Type InclusionCriterionTypeEnum `mandatory:"true" json:"type"`
// The current state of the inclusion criterion.
LifecycleState InclusionCriterionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Date and time the inclusion criterion was created. An RFC3339 formatted datetime string.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Date and time the inclusion criterion was updated. An RFC3339 formatted datetime string.
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
Association Association `mandatory:"false" json:"association"`
}
func (m InclusionCriterion) String() string
func (m *InclusionCriterion) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m InclusionCriterion) 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
InclusionCriterionCollection Results of a inclusion criterion search. Contains inclusion criterion summary items.
type InclusionCriterionCollection struct {
// List of inclusionCriteria.
Items []InclusionCriterionSummary `mandatory:"true" json:"items"`
}
func (m InclusionCriterionCollection) String() string
func (m InclusionCriterionCollection) 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
InclusionCriterionLifecycleStateEnum Enum with underlying type: string
type InclusionCriterionLifecycleStateEnum string
Set of constants representing the allowable values for InclusionCriterionLifecycleStateEnum
const (
InclusionCriterionLifecycleStateActive InclusionCriterionLifecycleStateEnum = "ACTIVE"
InclusionCriterionLifecycleStateDeleted InclusionCriterionLifecycleStateEnum = "DELETED"
)
func GetInclusionCriterionLifecycleStateEnumValues() []InclusionCriterionLifecycleStateEnum
GetInclusionCriterionLifecycleStateEnumValues Enumerates the set of values for InclusionCriterionLifecycleStateEnum
func GetMappingInclusionCriterionLifecycleStateEnum(val string) (InclusionCriterionLifecycleStateEnum, bool)
GetMappingInclusionCriterionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
InclusionCriterionSummary Summary of the inclusion criterion.
type InclusionCriterionSummary struct {
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the inclusion criterion.
Id *string `mandatory:"true" json:"id"`
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the governance rule. Every inclusion criterion is associated with a governance rule.
GovernanceRuleId *string `mandatory:"true" json:"governanceRuleId"`
// Type of inclusion criterion - TENANCY, ALL or TAG. We support TENANCY and ALL for now.
Type InclusionCriterionTypeEnum `mandatory:"true" json:"type"`
// The current state of the inclusion criterion.
LifecycleState InclusionCriterionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Date and time the inclusion criterion was created. An RFC3339 formatted datetime string.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Date and time the inclusion criterion was updated. An RFC3339 formatted datetime string.
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
Association Association `mandatory:"false" json:"association"`
}
func (m InclusionCriterionSummary) String() string
func (m *InclusionCriterionSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m InclusionCriterionSummary) 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
InclusionCriterionTypeEnum Enum with underlying type: string
type InclusionCriterionTypeEnum string
Set of constants representing the allowable values for InclusionCriterionTypeEnum
const (
InclusionCriterionTypeTenancy InclusionCriterionTypeEnum = "TENANCY"
InclusionCriterionTypeAll InclusionCriterionTypeEnum = "ALL"
)
func GetInclusionCriterionTypeEnumValues() []InclusionCriterionTypeEnum
GetInclusionCriterionTypeEnumValues Enumerates the set of values for InclusionCriterionTypeEnum
func GetMappingInclusionCriterionTypeEnum(val string) (InclusionCriterionTypeEnum, bool)
GetMappingInclusionCriterionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListEnforcedGovernanceRulesGovernanceRuleTypeEnum Enum with underlying type: string
type ListEnforcedGovernanceRulesGovernanceRuleTypeEnum string
Set of constants representing the allowable values for ListEnforcedGovernanceRulesGovernanceRuleTypeEnum
const (
ListEnforcedGovernanceRulesGovernanceRuleTypeQuota ListEnforcedGovernanceRulesGovernanceRuleTypeEnum = "QUOTA"
ListEnforcedGovernanceRulesGovernanceRuleTypeTag ListEnforcedGovernanceRulesGovernanceRuleTypeEnum = "TAG"
ListEnforcedGovernanceRulesGovernanceRuleTypeAllowedRegions ListEnforcedGovernanceRulesGovernanceRuleTypeEnum = "ALLOWED_REGIONS"
)
func GetListEnforcedGovernanceRulesGovernanceRuleTypeEnumValues() []ListEnforcedGovernanceRulesGovernanceRuleTypeEnum
GetListEnforcedGovernanceRulesGovernanceRuleTypeEnumValues Enumerates the set of values for ListEnforcedGovernanceRulesGovernanceRuleTypeEnum
func GetMappingListEnforcedGovernanceRulesGovernanceRuleTypeEnum(val string) (ListEnforcedGovernanceRulesGovernanceRuleTypeEnum, bool)
GetMappingListEnforcedGovernanceRulesGovernanceRuleTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListEnforcedGovernanceRulesRequest wrapper for the ListEnforcedGovernanceRules operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/ListEnforcedGovernanceRules.go.html to see an example of how to use ListEnforcedGovernanceRulesRequest.
type ListEnforcedGovernanceRulesRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// Unique enforced governance rule identifier.
EnforcedGovernanceRuleId *string `mandatory:"false" contributesTo:"query" name:"enforcedGovernanceRuleId"`
// A filter to return only resources that match the type given.
GovernanceRuleType ListEnforcedGovernanceRulesGovernanceRuleTypeEnum `mandatory:"false" contributesTo:"query" name:"governanceRuleType" omitEmpty:"true"`
// A filter to return only resources that match the entire name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListEnforcedGovernanceRulesSortOrderEnum `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.
SortBy ListEnforcedGovernanceRulesSortByEnum `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 ListEnforcedGovernanceRulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListEnforcedGovernanceRulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListEnforcedGovernanceRulesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListEnforcedGovernanceRulesRequest) String() string
func (request ListEnforcedGovernanceRulesRequest) 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
ListEnforcedGovernanceRulesResponse wrapper for the ListEnforcedGovernanceRules operation
type ListEnforcedGovernanceRulesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of EnforcedGovernanceRuleCollection instances
EnforcedGovernanceRuleCollection `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 ListEnforcedGovernanceRulesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListEnforcedGovernanceRulesResponse) String() string
ListEnforcedGovernanceRulesSortByEnum Enum with underlying type: string
type ListEnforcedGovernanceRulesSortByEnum string
Set of constants representing the allowable values for ListEnforcedGovernanceRulesSortByEnum
const (
ListEnforcedGovernanceRulesSortByTimecreated ListEnforcedGovernanceRulesSortByEnum = "timeCreated"
ListEnforcedGovernanceRulesSortByDisplayname ListEnforcedGovernanceRulesSortByEnum = "displayName"
)
func GetListEnforcedGovernanceRulesSortByEnumValues() []ListEnforcedGovernanceRulesSortByEnum
GetListEnforcedGovernanceRulesSortByEnumValues Enumerates the set of values for ListEnforcedGovernanceRulesSortByEnum
func GetMappingListEnforcedGovernanceRulesSortByEnum(val string) (ListEnforcedGovernanceRulesSortByEnum, bool)
GetMappingListEnforcedGovernanceRulesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListEnforcedGovernanceRulesSortOrderEnum Enum with underlying type: string
type ListEnforcedGovernanceRulesSortOrderEnum string
Set of constants representing the allowable values for ListEnforcedGovernanceRulesSortOrderEnum
const (
ListEnforcedGovernanceRulesSortOrderAsc ListEnforcedGovernanceRulesSortOrderEnum = "ASC"
ListEnforcedGovernanceRulesSortOrderDesc ListEnforcedGovernanceRulesSortOrderEnum = "DESC"
)
func GetListEnforcedGovernanceRulesSortOrderEnumValues() []ListEnforcedGovernanceRulesSortOrderEnum
GetListEnforcedGovernanceRulesSortOrderEnumValues Enumerates the set of values for ListEnforcedGovernanceRulesSortOrderEnum
func GetMappingListEnforcedGovernanceRulesSortOrderEnum(val string) (ListEnforcedGovernanceRulesSortOrderEnum, bool)
GetMappingListEnforcedGovernanceRulesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListGovernanceRulesGovernanceRuleTypeEnum Enum with underlying type: string
type ListGovernanceRulesGovernanceRuleTypeEnum string
Set of constants representing the allowable values for ListGovernanceRulesGovernanceRuleTypeEnum
const (
ListGovernanceRulesGovernanceRuleTypeQuota ListGovernanceRulesGovernanceRuleTypeEnum = "QUOTA"
ListGovernanceRulesGovernanceRuleTypeTag ListGovernanceRulesGovernanceRuleTypeEnum = "TAG"
ListGovernanceRulesGovernanceRuleTypeAllowedRegions ListGovernanceRulesGovernanceRuleTypeEnum = "ALLOWED_REGIONS"
)
func GetListGovernanceRulesGovernanceRuleTypeEnumValues() []ListGovernanceRulesGovernanceRuleTypeEnum
GetListGovernanceRulesGovernanceRuleTypeEnumValues Enumerates the set of values for ListGovernanceRulesGovernanceRuleTypeEnum
func GetMappingListGovernanceRulesGovernanceRuleTypeEnum(val string) (ListGovernanceRulesGovernanceRuleTypeEnum, bool)
GetMappingListGovernanceRulesGovernanceRuleTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListGovernanceRulesLifecycleStateEnum Enum with underlying type: string
type ListGovernanceRulesLifecycleStateEnum string
Set of constants representing the allowable values for ListGovernanceRulesLifecycleStateEnum
const (
ListGovernanceRulesLifecycleStateActive ListGovernanceRulesLifecycleStateEnum = "ACTIVE"
ListGovernanceRulesLifecycleStateDeleted ListGovernanceRulesLifecycleStateEnum = "DELETED"
)
func GetListGovernanceRulesLifecycleStateEnumValues() []ListGovernanceRulesLifecycleStateEnum
GetListGovernanceRulesLifecycleStateEnumValues Enumerates the set of values for ListGovernanceRulesLifecycleStateEnum
func GetMappingListGovernanceRulesLifecycleStateEnum(val string) (ListGovernanceRulesLifecycleStateEnum, bool)
GetMappingListGovernanceRulesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListGovernanceRulesRequest wrapper for the ListGovernanceRules operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/ListGovernanceRules.go.html to see an example of how to use ListGovernanceRulesRequest.
type ListGovernanceRulesRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// Unique governance rule identifier.
GovernanceRuleId *string `mandatory:"false" contributesTo:"query" name:"governanceRuleId"`
// A filter to return only resources whose lifecycle state matches the given lifecycle state.
LifecycleState ListGovernanceRulesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the entire name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match the type given.
GovernanceRuleType ListGovernanceRulesGovernanceRuleTypeEnum `mandatory:"false" contributesTo:"query" name:"governanceRuleType" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListGovernanceRulesSortOrderEnum `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.
SortBy ListGovernanceRulesSortByEnum `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 ListGovernanceRulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListGovernanceRulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListGovernanceRulesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListGovernanceRulesRequest) String() string
func (request ListGovernanceRulesRequest) 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
ListGovernanceRulesResponse wrapper for the ListGovernanceRules operation
type ListGovernanceRulesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of GovernanceRuleCollection instances
GovernanceRuleCollection `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 ListGovernanceRulesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListGovernanceRulesResponse) String() string
ListGovernanceRulesSortByEnum Enum with underlying type: string
type ListGovernanceRulesSortByEnum string
Set of constants representing the allowable values for ListGovernanceRulesSortByEnum
const (
ListGovernanceRulesSortByTimecreated ListGovernanceRulesSortByEnum = "timeCreated"
ListGovernanceRulesSortByDisplayname ListGovernanceRulesSortByEnum = "displayName"
)
func GetListGovernanceRulesSortByEnumValues() []ListGovernanceRulesSortByEnum
GetListGovernanceRulesSortByEnumValues Enumerates the set of values for ListGovernanceRulesSortByEnum
func GetMappingListGovernanceRulesSortByEnum(val string) (ListGovernanceRulesSortByEnum, bool)
GetMappingListGovernanceRulesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListGovernanceRulesSortOrderEnum Enum with underlying type: string
type ListGovernanceRulesSortOrderEnum string
Set of constants representing the allowable values for ListGovernanceRulesSortOrderEnum
const (
ListGovernanceRulesSortOrderAsc ListGovernanceRulesSortOrderEnum = "ASC"
ListGovernanceRulesSortOrderDesc ListGovernanceRulesSortOrderEnum = "DESC"
)
func GetListGovernanceRulesSortOrderEnumValues() []ListGovernanceRulesSortOrderEnum
GetListGovernanceRulesSortOrderEnumValues Enumerates the set of values for ListGovernanceRulesSortOrderEnum
func GetMappingListGovernanceRulesSortOrderEnum(val string) (ListGovernanceRulesSortOrderEnum, bool)
GetMappingListGovernanceRulesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListInclusionCriteriaRequest wrapper for the ListInclusionCriteria operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/ListInclusionCriteria.go.html to see an example of how to use ListInclusionCriteriaRequest.
type ListInclusionCriteriaRequest struct {
// Unique governance rule identifier.
GovernanceRuleId *string `mandatory:"true" contributesTo:"query" name:"governanceRuleId"`
// Unique inclusion criterion identifier.
InclusionCriterionId *string `mandatory:"false" contributesTo:"query" name:"inclusionCriterionId"`
// A filter to return only resources when their lifecycle state matches the given lifecycle state.
LifecycleState InclusionCriterionLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListInclusionCriteriaSortOrderEnum `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.
SortBy ListInclusionCriteriaSortByEnum `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 ListInclusionCriteriaRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListInclusionCriteriaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListInclusionCriteriaRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListInclusionCriteriaRequest) String() string
func (request ListInclusionCriteriaRequest) 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
ListInclusionCriteriaResponse wrapper for the ListInclusionCriteria operation
type ListInclusionCriteriaResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of InclusionCriterionCollection instances
InclusionCriterionCollection `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 ListInclusionCriteriaResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListInclusionCriteriaResponse) String() string
ListInclusionCriteriaSortByEnum Enum with underlying type: string
type ListInclusionCriteriaSortByEnum string
Set of constants representing the allowable values for ListInclusionCriteriaSortByEnum
const (
ListInclusionCriteriaSortByTimecreated ListInclusionCriteriaSortByEnum = "timeCreated"
ListInclusionCriteriaSortByDisplayname ListInclusionCriteriaSortByEnum = "displayName"
)
func GetListInclusionCriteriaSortByEnumValues() []ListInclusionCriteriaSortByEnum
GetListInclusionCriteriaSortByEnumValues Enumerates the set of values for ListInclusionCriteriaSortByEnum
func GetMappingListInclusionCriteriaSortByEnum(val string) (ListInclusionCriteriaSortByEnum, bool)
GetMappingListInclusionCriteriaSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListInclusionCriteriaSortOrderEnum Enum with underlying type: string
type ListInclusionCriteriaSortOrderEnum string
Set of constants representing the allowable values for ListInclusionCriteriaSortOrderEnum
const (
ListInclusionCriteriaSortOrderAsc ListInclusionCriteriaSortOrderEnum = "ASC"
ListInclusionCriteriaSortOrderDesc ListInclusionCriteriaSortOrderEnum = "DESC"
)
func GetListInclusionCriteriaSortOrderEnumValues() []ListInclusionCriteriaSortOrderEnum
GetListInclusionCriteriaSortOrderEnumValues Enumerates the set of values for ListInclusionCriteriaSortOrderEnum
func GetMappingListInclusionCriteriaSortOrderEnum(val string) (ListInclusionCriteriaSortOrderEnum, bool)
GetMappingListInclusionCriteriaSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListTenancyAttachmentsRequest wrapper for the ListTenancyAttachments operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/ListTenancyAttachments.go.html to see an example of how to use ListTenancyAttachmentsRequest.
type ListTenancyAttachmentsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// Unique tenancy attachment identifier.
TenancyAttachmentId *string `mandatory:"false" contributesTo:"query" name:"tenancyAttachmentId"`
// Unique governance rule identifier.
GovernanceRuleId *string `mandatory:"false" contributesTo:"query" name:"governanceRuleId"`
// A filter to return only resources when their lifecycle state matches the given lifecycle state.
LifecycleState TenancyAttachmentLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only governance rules that match the given tenancy id.
ChildTenancyId *string `mandatory:"false" contributesTo:"query" name:"childTenancyId"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListTenancyAttachmentsSortOrderEnum `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.
SortBy ListTenancyAttachmentsSortByEnum `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 ListTenancyAttachmentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListTenancyAttachmentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListTenancyAttachmentsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListTenancyAttachmentsRequest) String() string
func (request ListTenancyAttachmentsRequest) 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
ListTenancyAttachmentsResponse wrapper for the ListTenancyAttachments operation
type ListTenancyAttachmentsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of TenancyAttachmentCollection instances
TenancyAttachmentCollection `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 ListTenancyAttachmentsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListTenancyAttachmentsResponse) String() string
ListTenancyAttachmentsSortByEnum Enum with underlying type: string
type ListTenancyAttachmentsSortByEnum string
Set of constants representing the allowable values for ListTenancyAttachmentsSortByEnum
const (
ListTenancyAttachmentsSortByTimecreated ListTenancyAttachmentsSortByEnum = "timeCreated"
ListTenancyAttachmentsSortByDisplayname ListTenancyAttachmentsSortByEnum = "displayName"
)
func GetListTenancyAttachmentsSortByEnumValues() []ListTenancyAttachmentsSortByEnum
GetListTenancyAttachmentsSortByEnumValues Enumerates the set of values for ListTenancyAttachmentsSortByEnum
func GetMappingListTenancyAttachmentsSortByEnum(val string) (ListTenancyAttachmentsSortByEnum, bool)
GetMappingListTenancyAttachmentsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListTenancyAttachmentsSortOrderEnum Enum with underlying type: string
type ListTenancyAttachmentsSortOrderEnum string
Set of constants representing the allowable values for ListTenancyAttachmentsSortOrderEnum
const (
ListTenancyAttachmentsSortOrderAsc ListTenancyAttachmentsSortOrderEnum = "ASC"
ListTenancyAttachmentsSortOrderDesc ListTenancyAttachmentsSortOrderEnum = "DESC"
)
func GetListTenancyAttachmentsSortOrderEnumValues() []ListTenancyAttachmentsSortOrderEnum
GetListTenancyAttachmentsSortOrderEnumValues Enumerates the set of values for ListTenancyAttachmentsSortOrderEnum
func GetMappingListTenancyAttachmentsSortOrderEnum(val string) (ListTenancyAttachmentsSortOrderEnum, bool)
GetMappingListTenancyAttachmentsSortOrderEnum 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/governancerulescontrolplane/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"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.
SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListWorkRequestErrorsSortOrderEnum `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 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 WorkRequestErrorCollection instances
WorkRequestErrorCollection `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
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByTimeaccepted ListWorkRequestErrorsSortByEnum = "timeAccepted"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const (
ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC"
ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/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"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.
SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListWorkRequestLogsSortOrderEnum `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 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 WorkRequestLogEntryCollection instances
WorkRequestLogEntryCollection `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
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByTimeaccepted ListWorkRequestLogsSortByEnum = "timeAccepted"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/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:"false" contributesTo:"query" name:"compartmentId"`
// The ID of the asynchronous work request.
WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`
// A filter to return only resources their lifecycleState matches the given OperationStatus.
Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// The ID of the resource affected by the work request.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.
SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" 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 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 WorkRequestSummaryCollection instances
WorkRequestSummaryCollection `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
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)
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
ListWorkRequestsStatusEnum Enum with underlying type: string
type ListWorkRequestsStatusEnum string
Set of constants representing the allowable values for ListWorkRequestsStatusEnum
const (
ListWorkRequestsStatusAccepted ListWorkRequestsStatusEnum = "ACCEPTED"
ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS"
ListWorkRequestsStatusWaiting ListWorkRequestsStatusEnum = "WAITING"
ListWorkRequestsStatusFailed ListWorkRequestsStatusEnum = "FAILED"
ListWorkRequestsStatusSucceeded ListWorkRequestsStatusEnum = "SUCCEEDED"
ListWorkRequestsStatusCanceling ListWorkRequestsStatusEnum = "CANCELING"
ListWorkRequestsStatusCanceled ListWorkRequestsStatusEnum = "CANCELED"
)
func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum
GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum
func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)
GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
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"
OperationStatusWaiting OperationStatusEnum = "WAITING"
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
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
const (
OperationTypeCreateGovernanceRule OperationTypeEnum = "CREATE_GOVERNANCE_RULE"
OperationTypeUpdateGovernanceRule OperationTypeEnum = "UPDATE_GOVERNANCE_RULE"
OperationTypeDeleteGovernanceRule OperationTypeEnum = "DELETE_GOVERNANCE_RULE"
OperationTypeRetryGovernanceRule OperationTypeEnum = "RETRY_GOVERNANCE_RULE"
OperationTypeCreateInclusionCriteria OperationTypeEnum = "CREATE_INCLUSION_CRITERIA"
OperationTypeDeleteInclusionCriteria OperationTypeEnum = "DELETE_INCLUSION_CRITERIA"
OperationTypeRetryTenancyAttachment OperationTypeEnum = "RETRY_TENANCY_ATTACHMENT"
OperationTypeApplyTenancyAttachment OperationTypeEnum = "APPLY_TENANCY_ATTACHMENT"
OperationTypeCreateEnforcedQuotaGovernanceRule OperationTypeEnum = "CREATE_ENFORCED_QUOTA_GOVERNANCE_RULE"
OperationTypeCreateEnforcedTagGovernanceRule OperationTypeEnum = "CREATE_ENFORCED_TAG_GOVERNANCE_RULE"
OperationTypeUpdateEnforcedQuotaGovernanceRule OperationTypeEnum = "UPDATE_ENFORCED_QUOTA_GOVERNANCE_RULE"
OperationTypeUpdateEnforcedTagGovernanceRule OperationTypeEnum = "UPDATE_ENFORCED_TAG_GOVERNANCE_RULE"
OperationTypeDeleteEnforcedQuotaGovernanceRule OperationTypeEnum = "DELETE_ENFORCED_QUOTA_GOVERNANCE_RULE"
OperationTypeDeleteEnforcedTagGovernanceRule OperationTypeEnum = "DELETE_ENFORCED_TAG_GOVERNANCE_RULE"
OperationTypeTenantManagerOptInEventHandler OperationTypeEnum = "TENANT_MANAGER_OPT_IN_EVENT_HANDLER"
OperationTypeTenantManagerOptOutEventHandler OperationTypeEnum = "TENANT_MANAGER_OPT_OUT_EVENT_HANDLER"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
QuotaTemplate Quota template for governance rule.
type QuotaTemplate struct {
// Display name of the quota resource.
DisplayName *string `mandatory:"true" json:"displayName"`
// List of quota statements.
Statements []string `mandatory:"true" json:"statements"`
// Description of the quota resource.
Description *string `mandatory:"false" json:"description"`
}
func (m QuotaTemplate) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m QuotaTemplate) String() string
func (m QuotaTemplate) 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
RetryGovernanceRuleRequest wrapper for the RetryGovernanceRule operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/RetryGovernanceRule.go.html to see an example of how to use RetryGovernanceRuleRequest.
type RetryGovernanceRuleRequest struct {
// Unique governance rule identifier.
GovernanceRuleId *string `mandatory:"true" contributesTo:"path" name:"governanceRuleId"`
// 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
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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"`
// 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 RetryGovernanceRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RetryGovernanceRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RetryGovernanceRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RetryGovernanceRuleRequest) String() string
func (request RetryGovernanceRuleRequest) 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
RetryGovernanceRuleResponse wrapper for the RetryGovernanceRule operation
type RetryGovernanceRuleResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
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 RetryGovernanceRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RetryGovernanceRuleResponse) String() string
RetryTenancyAttachmentRequest wrapper for the RetryTenancyAttachment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/RetryTenancyAttachment.go.html to see an example of how to use RetryTenancyAttachmentRequest.
type RetryTenancyAttachmentRequest struct {
// Unique tenancy attachment identifier.
TenancyAttachmentId *string `mandatory:"true" contributesTo:"path" name:"tenancyAttachmentId"`
// 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
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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"`
// 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 RetryTenancyAttachmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RetryTenancyAttachmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RetryTenancyAttachmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RetryTenancyAttachmentRequest) String() string
func (request RetryTenancyAttachmentRequest) 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
RetryTenancyAttachmentResponse wrapper for the RetryTenancyAttachment operation
type RetryTenancyAttachmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
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 RetryTenancyAttachmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RetryTenancyAttachmentResponse) String() string
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
Tag Details of the tag that is being created.
type Tag struct {
// The name you assign to the tag during creation. This is the tag key definition.
// The name must be unique within the tag namespace and cannot be changed.
Name *string `mandatory:"true" json:"name"`
// The description assigned to the tag during creation.
Description *string `mandatory:"false" json:"description"`
// Indicates whether the tag is enabled for cost tracking.
IsCostTracking *bool `mandatory:"false" json:"isCostTracking"`
Validator BaseTagDefinitionValidator `mandatory:"false" json:"validator"`
}
func (m Tag) String() string
func (m *Tag) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m Tag) 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
TagDefault Tag defaults let you specify a default tag (tagnamespace.tag="value") to apply to all resource types in a specified compartment. The tag default is applied at the time the resource is created. Resources that exist in the compartment before you create the tag default are not tagged.
type TagDefault struct {
// The name of the tag. The tag default will always assign a default value for this tag name.
TagName *string `mandatory:"true" json:"tagName"`
// The default value for the tag name. This will be applied to all new resources created in the compartment.
Value *string `mandatory:"true" json:"value"`
// If you specify that a value is required, a value is set during resource creation (either by
// the user creating the resource or another tag default). If no value is set, resource
// creation is blocked.
// * If the `isRequired` flag is set to "true", the value is set during resource creation.
// * If the `isRequired` flag is set to "false", the value you enter is set during resource creation.
// Example: `false`
IsRequired *bool `mandatory:"true" json:"isRequired"`
}
func (m TagDefault) String() string
func (m TagDefault) 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
TagTemplate Template for governance rules of type tag.
type TagTemplate struct {
// The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.
Name *string `mandatory:"true" json:"name"`
// Description of the tag namespace.
Description *string `mandatory:"false" json:"description"`
// Represents an array of tags for tag namespace.
Tags []Tag `mandatory:"false" json:"tags"`
TagDefaults []TagDefault `mandatory:"false" json:"tagDefaults"`
}
func (m TagTemplate) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TagTemplate) String() string
func (m TagTemplate) 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
Template Template object for the governance rule. It could be of type QUOTA, TAG or REGION_RESTRICTION.
type Template interface {
}
TenancyAssociation Tenancy association represents the tenancy id to which the governance rule will be applied.
type TenancyAssociation struct {
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the tenancy to which the governance rule will be applied as part of this tenancy inclusion criterion.
TenancyId *string `mandatory:"true" json:"tenancyId"`
}
func (m TenancyAssociation) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TenancyAssociation) String() string
func (m TenancyAssociation) 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
TenancyAttachment Tenancy attachment associates a tenancy to a governance rule via an inclusion criterion.
type TenancyAttachment struct {
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the tenancy attachment.
Id *string `mandatory:"true" json:"id"`
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the root compartment containing the tenancy attachment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the governance rule. Every tenancy attachment is associated with a governance rule.
GovernanceRuleId *string `mandatory:"true" json:"governanceRuleId"`
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the tenancy to which the governance rule is attached.
TenancyId *string `mandatory:"true" json:"tenancyId"`
// The current state of the tenancy attachment.
LifecycleState TenancyAttachmentLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Date and time the tenancy attachment was created. An RFC3339 formatted datetime string.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Date and time the tenancy attachment was updated. An RFC3339 formatted datetime string.
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Date and time the tenancy attachment was last attempted. An RFC3339 formatted datetime string.
// Example: `2016-08-25T21:10:29.600Z`
TimeLastAttempted *common.SDKTime `mandatory:"false" json:"timeLastAttempted"`
}
func (m TenancyAttachment) String() string
func (m TenancyAttachment) 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
TenancyAttachmentCollection Results of a tenancy attachment search. Contains tenancy attachment summary items.
type TenancyAttachmentCollection struct {
// List of tenancy attachments.
Items []TenancyAttachmentSummary `mandatory:"true" json:"items"`
}
func (m TenancyAttachmentCollection) String() string
func (m TenancyAttachmentCollection) 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
TenancyAttachmentLifecycleStateEnum Enum with underlying type: string
type TenancyAttachmentLifecycleStateEnum string
Set of constants representing the allowable values for TenancyAttachmentLifecycleStateEnum
const (
TenancyAttachmentLifecycleStateCreating TenancyAttachmentLifecycleStateEnum = "CREATING"
TenancyAttachmentLifecycleStateActive TenancyAttachmentLifecycleStateEnum = "ACTIVE"
TenancyAttachmentLifecycleStateUpdating TenancyAttachmentLifecycleStateEnum = "UPDATING"
TenancyAttachmentLifecycleStateNeedsAttention TenancyAttachmentLifecycleStateEnum = "NEEDS_ATTENTION"
TenancyAttachmentLifecycleStateDeleting TenancyAttachmentLifecycleStateEnum = "DELETING"
TenancyAttachmentLifecycleStateDeleted TenancyAttachmentLifecycleStateEnum = "DELETED"
)
func GetMappingTenancyAttachmentLifecycleStateEnum(val string) (TenancyAttachmentLifecycleStateEnum, bool)
GetMappingTenancyAttachmentLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTenancyAttachmentLifecycleStateEnumValues() []TenancyAttachmentLifecycleStateEnum
GetTenancyAttachmentLifecycleStateEnumValues Enumerates the set of values for TenancyAttachmentLifecycleStateEnum
TenancyAttachmentSummary Summary of the tenancy attachment.
type TenancyAttachmentSummary struct {
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the tenancy attachment.
Id *string `mandatory:"true" json:"id"`
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the root compartment containing the tenancy attachment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the governance rule. Every tenancy attachment is associated with a governance rule.
GovernanceRuleId *string `mandatory:"true" json:"governanceRuleId"`
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the tenancy to which the governance rule is attached.
TenancyId *string `mandatory:"true" json:"tenancyId"`
// The current state of the tenancy attachment.
LifecycleState TenancyAttachmentLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Date and time the tenancy attachment was created. An RFC3339 formatted datetime string.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Date and time the tenancy attachment was updated. An RFC3339 formatted datetime string.
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Date and time the tenancy attachment was last attempted. An RFC3339 formatted datetime string.
// Example: `2016-08-25T21:10:29.600Z`
TimeLastAttempted *common.SDKTime `mandatory:"false" json:"timeLastAttempted"`
}
func (m TenancyAttachmentSummary) String() string
func (m TenancyAttachmentSummary) 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
UpdateGovernanceRuleDetails Request object for UpdateGovernanceRule operation.
type UpdateGovernanceRuleDetails struct {
// Display name of the governance rule.
DisplayName *string `mandatory:"false" json:"displayName"`
// Description of the governance rule.
Description *string `mandatory:"false" json:"description"`
Template Template `mandatory:"false" json:"template"`
// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the resource, which was used as a template to create this governance rule.
RelatedResourceId *string `mandatory:"false" json:"relatedResourceId"`
// 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 UpdateGovernanceRuleDetails) String() string
func (m *UpdateGovernanceRuleDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateGovernanceRuleDetails) 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
UpdateGovernanceRuleRequest wrapper for the UpdateGovernanceRule operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/UpdateGovernanceRule.go.html to see an example of how to use UpdateGovernanceRuleRequest.
type UpdateGovernanceRuleRequest struct {
// Unique governance rule identifier.
GovernanceRuleId *string `mandatory:"true" contributesTo:"path" name:"governanceRuleId"`
// Details to update the governance rule.
UpdateGovernanceRuleDetails `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"`
// 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 UpdateGovernanceRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateGovernanceRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateGovernanceRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateGovernanceRuleRequest) String() string
func (request UpdateGovernanceRuleRequest) 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
UpdateGovernanceRuleResponse wrapper for the UpdateGovernanceRule operation
type UpdateGovernanceRuleResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
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 UpdateGovernanceRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateGovernanceRuleResponse) String() string
WorkRequest A description of workrequest status
type WorkRequest struct {
// Type of the work request
OperationType OperationTypeEnum `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. Work requests should be scoped to
// the same compartment as the resource the work request affects. If the work request affects multiple resources,
// and those resources are not in the same compartment, it is up to the service team to pick the primary
// resource whose compartment should be used
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this 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).
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
WorkRequestClient a client for WorkRequest
type WorkRequestClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewWorkRequestClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client WorkRequestClient, err error)
NewWorkRequestClientWithConfigurationProvider Creates a new default WorkRequest client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewWorkRequestClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client WorkRequestClient, err error)
NewWorkRequestClientWithOboToken Creates a new default WorkRequest 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 WorkRequestClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)
CancelWorkRequest Cancels the work request with the given ID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequest API.
func (client *WorkRequestClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client WorkRequestClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets details of the work request with the given ID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API.
func (client WorkRequestClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Returns a (paginated) list of errors for the work request with the given ID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API.
func (client WorkRequestClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Returns a (paginated) list of logs for the work request with the given ID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API.
func (client WorkRequestClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/governancerulescontrolplane/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API.
func (client *WorkRequestClient) SetRegion(region string)
SetRegion overrides the region of this client.
WorkRequestError An error encountered while executing a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occured. Error codes are listed on
// (https://docs.cloud.oracle.com/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 occured. An RFC3339 formatted datetime string.
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
WorkRequestErrorCollection Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
type WorkRequestErrorCollection struct {
// List of workRequestError objects.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
func (m WorkRequestErrorCollection) 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 log message was written. An RFC3339 formatted datetime string
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
WorkRequestLogEntryCollection Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
type WorkRequestLogEntryCollection struct {
// List of workRequestLogEntries.
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
func (m WorkRequestLogEntryCollection) 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 A resource created or operated on by a work request.
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 ActionTypeEnum `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"`
// Additional information that helps to explain 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
WorkRequestResourceMetadataKeyEnum Enum with underlying type: string
type WorkRequestResourceMetadataKeyEnum string
Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum
const (
WorkRequestResourceMetadataKeyIsDryRun WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
)
func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)
GetMappingWorkRequestResourceMetadataKeyEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum
GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum
WorkRequestSummary A summary of the status of a work request.
type WorkRequestSummary struct {
// Type of the work request
OperationType OperationTypeEnum `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. Work requests should be scoped to
// the same compartment as the resource the work request affects. If the work request affects multiple resources,
// and those resources are not in the same compartment, it is up to the service team to pick the primary
// resource whose compartment should be used
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this 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).
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
WorkRequestSummaryCollection Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
type WorkRequestSummaryCollection struct {
// List of workRequestSummary objects.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
func (m WorkRequestSummaryCollection) String() string
func (m WorkRequestSummaryCollection) 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