func GetInstanceLifecycleStateEnumStringValues() []string
GetInstanceLifecycleStateEnumStringValues Enumerates the set of values in String for InstanceLifecycleStateEnum
func GetLicenseTypeEnumStringValues() []string
GetLicenseTypeEnumStringValues Enumerates the set of values in String for LicenseTypeEnum
func GetListGovernanceInstancesSortByEnumStringValues() []string
GetListGovernanceInstancesSortByEnumStringValues Enumerates the set of values in String for ListGovernanceInstancesSortByEnum
func GetListGovernanceInstancesSortOrderEnumStringValues() []string
GetListGovernanceInstancesSortOrderEnumStringValues Enumerates the set of values in String for ListGovernanceInstancesSortOrderEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
AccessGovernanceCPClient a client for AccessGovernanceCP
type AccessGovernanceCPClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewAccessGovernanceCPClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client AccessGovernanceCPClient, err error)
NewAccessGovernanceCPClientWithConfigurationProvider Creates a new default AccessGovernanceCP client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewAccessGovernanceCPClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client AccessGovernanceCPClient, err error)
NewAccessGovernanceCPClientWithOboToken Creates a new default AccessGovernanceCP 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 AccessGovernanceCPClient) ChangeGovernanceInstanceCompartment(ctx context.Context, request ChangeGovernanceInstanceCompartmentRequest) (response ChangeGovernanceInstanceCompartmentResponse, err error)
ChangeGovernanceInstanceCompartment Moves a GovernanceInstance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/accessgovernancecp/ChangeGovernanceInstanceCompartment.go.html to see an example of how to use ChangeGovernanceInstanceCompartment API. A default retry strategy applies to this operation ChangeGovernanceInstanceCompartment()
func (client *AccessGovernanceCPClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client AccessGovernanceCPClient) CreateGovernanceInstance(ctx context.Context, request CreateGovernanceInstanceRequest) (response CreateGovernanceInstanceResponse, err error)
CreateGovernanceInstance Creates a new GovernanceInstance.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/accessgovernancecp/CreateGovernanceInstance.go.html to see an example of how to use CreateGovernanceInstance API. A default retry strategy applies to this operation CreateGovernanceInstance()
func (client AccessGovernanceCPClient) DeleteGovernanceInstance(ctx context.Context, request DeleteGovernanceInstanceRequest) (response DeleteGovernanceInstanceResponse, err error)
DeleteGovernanceInstance Deletes an existing GovernanceInstance.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/accessgovernancecp/DeleteGovernanceInstance.go.html to see an example of how to use DeleteGovernanceInstance API. A default retry strategy applies to this operation DeleteGovernanceInstance()
func (client AccessGovernanceCPClient) GetGovernanceInstance(ctx context.Context, request GetGovernanceInstanceRequest) (response GetGovernanceInstanceResponse, err error)
GetGovernanceInstance Gets a GovernanceInstance by OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/accessgovernancecp/GetGovernanceInstance.go.html to see an example of how to use GetGovernanceInstance API. A default retry strategy applies to this operation GetGovernanceInstance()
func (client AccessGovernanceCPClient) GetGovernanceInstanceConfiguration(ctx context.Context, request GetGovernanceInstanceConfigurationRequest) (response GetGovernanceInstanceConfigurationResponse, err error)
GetGovernanceInstanceConfiguration Gets the tenancy-wide configuration for GovernanceInstances
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/accessgovernancecp/GetGovernanceInstanceConfiguration.go.html to see an example of how to use GetGovernanceInstanceConfiguration API. A default retry strategy applies to this operation GetGovernanceInstanceConfiguration()
func (client AccessGovernanceCPClient) ListGovernanceInstances(ctx context.Context, request ListGovernanceInstancesRequest) (response ListGovernanceInstancesResponse, err error)
ListGovernanceInstances Returns a list of Governance Instances.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/accessgovernancecp/ListGovernanceInstances.go.html to see an example of how to use ListGovernanceInstances API. A default retry strategy applies to this operation ListGovernanceInstances()
func (client *AccessGovernanceCPClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client AccessGovernanceCPClient) UpdateGovernanceInstance(ctx context.Context, request UpdateGovernanceInstanceRequest) (response UpdateGovernanceInstanceResponse, err error)
UpdateGovernanceInstance Updates the GovernanceInstance.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/accessgovernancecp/UpdateGovernanceInstance.go.html to see an example of how to use UpdateGovernanceInstance API. A default retry strategy applies to this operation UpdateGovernanceInstance()
func (client AccessGovernanceCPClient) UpdateGovernanceInstanceConfiguration(ctx context.Context, request UpdateGovernanceInstanceConfigurationRequest) (response UpdateGovernanceInstanceConfigurationResponse, err error)
UpdateGovernanceInstanceConfiguration Updates the tenancy-wide configuration for GovernanceInstances
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/accessgovernancecp/UpdateGovernanceInstanceConfiguration.go.html to see an example of how to use UpdateGovernanceInstanceConfiguration API. A default retry strategy applies to this operation UpdateGovernanceInstanceConfiguration()
ChangeGovernanceInstanceCompartmentDetails The details of a GovernanceInstance to be updated for a compartment change.
type ChangeGovernanceInstanceCompartmentDetails struct {
// The OCID of the compartment where the GovernanceInstance resides.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeGovernanceInstanceCompartmentDetails) String() string
func (m ChangeGovernanceInstanceCompartmentDetails) 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
ChangeGovernanceInstanceCompartmentRequest wrapper for the ChangeGovernanceInstanceCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/accessgovernancecp/ChangeGovernanceInstanceCompartment.go.html to see an example of how to use ChangeGovernanceInstanceCompartmentRequest.
type ChangeGovernanceInstanceCompartmentRequest struct {
// The OCID of the GovernanceInstance
GovernanceInstanceId *string `mandatory:"true" contributesTo:"path" name:"governanceInstanceId"`
// The details to change the compartment of a GovernanceInstance.
ChangeGovernanceInstanceCompartmentDetails `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"`
// 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"`
// 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 ChangeGovernanceInstanceCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeGovernanceInstanceCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeGovernanceInstanceCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeGovernanceInstanceCompartmentRequest) String() string
func (request ChangeGovernanceInstanceCompartmentRequest) 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
ChangeGovernanceInstanceCompartmentResponse wrapper for the ChangeGovernanceInstanceCompartment operation
type ChangeGovernanceInstanceCompartmentResponse 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 ChangeGovernanceInstanceCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeGovernanceInstanceCompartmentResponse) String() string
CreateGovernanceInstanceDetails The details about a new GovernanceInstance.
type CreateGovernanceInstanceDetails struct {
// The name for the GovernanceInstance.
DisplayName *string `mandatory:"true" json:"displayName"`
// The licenseType being used.
LicenseType LicenseTypeEnum `mandatory:"true" json:"licenseType"`
// The namespace for tenancy object storage.
TenancyNamespace *string `mandatory:"true" json:"tenancyNamespace"`
// The OCID of the compartment where the GovernanceInstance resides.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// IDCS access token identifying a stripe and service administrator user.
IdcsAccessToken *string `mandatory:"true" json:"idcsAccessToken"`
// The description of the GovernanceInstance.
Description *string `mandatory:"false" json:"description"`
// 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"`
// 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"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m CreateGovernanceInstanceDetails) String() string
func (m CreateGovernanceInstanceDetails) 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
CreateGovernanceInstanceRequest wrapper for the CreateGovernanceInstance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/accessgovernancecp/CreateGovernanceInstance.go.html to see an example of how to use CreateGovernanceInstanceRequest.
type CreateGovernanceInstanceRequest struct {
// The details of a new GovernanceInstance.
CreateGovernanceInstanceDetails `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 CreateGovernanceInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateGovernanceInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateGovernanceInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateGovernanceInstanceRequest) String() string
func (request CreateGovernanceInstanceRequest) 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
CreateGovernanceInstanceResponse wrapper for the CreateGovernanceInstance operation
type CreateGovernanceInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// The GovernanceInstance instance
GovernanceInstance `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateGovernanceInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateGovernanceInstanceResponse) String() string
DeleteGovernanceInstanceRequest wrapper for the DeleteGovernanceInstance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/accessgovernancecp/DeleteGovernanceInstance.go.html to see an example of how to use DeleteGovernanceInstanceRequest.
type DeleteGovernanceInstanceRequest struct {
// The OCID of the GovernanceInstance
GovernanceInstanceId *string `mandatory:"true" contributesTo:"path" name:"governanceInstanceId"`
// 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"`
// 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 DeleteGovernanceInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteGovernanceInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteGovernanceInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteGovernanceInstanceRequest) String() string
func (request DeleteGovernanceInstanceRequest) 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
DeleteGovernanceInstanceResponse wrapper for the DeleteGovernanceInstance operation
type DeleteGovernanceInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteGovernanceInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteGovernanceInstanceResponse) String() string
GetGovernanceInstanceConfigurationRequest wrapper for the GetGovernanceInstanceConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/accessgovernancecp/GetGovernanceInstanceConfiguration.go.html to see an example of how to use GetGovernanceInstanceConfigurationRequest.
type GetGovernanceInstanceConfigurationRequest struct {
// The OCID of the compartment in which resources are listed.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// 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 GetGovernanceInstanceConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetGovernanceInstanceConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetGovernanceInstanceConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetGovernanceInstanceConfigurationRequest) String() string
func (request GetGovernanceInstanceConfigurationRequest) 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
GetGovernanceInstanceConfigurationResponse wrapper for the GetGovernanceInstanceConfiguration operation
type GetGovernanceInstanceConfigurationResponse struct {
// The underlying http response
RawResponse *http.Response
// The GovernanceInstanceConfiguration instance
GovernanceInstanceConfiguration `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 GetGovernanceInstanceConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetGovernanceInstanceConfigurationResponse) String() string
GetGovernanceInstanceRequest wrapper for the GetGovernanceInstance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/accessgovernancecp/GetGovernanceInstance.go.html to see an example of how to use GetGovernanceInstanceRequest.
type GetGovernanceInstanceRequest struct {
// The OCID of the GovernanceInstance
GovernanceInstanceId *string `mandatory:"true" contributesTo:"path" name:"governanceInstanceId"`
// 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 GetGovernanceInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetGovernanceInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetGovernanceInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetGovernanceInstanceRequest) String() string
func (request GetGovernanceInstanceRequest) 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
GetGovernanceInstanceResponse wrapper for the GetGovernanceInstance operation
type GetGovernanceInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// The GovernanceInstance instance
GovernanceInstance `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 GetGovernanceInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetGovernanceInstanceResponse) String() string
GovernanceInstance The details of a GovenanceInstance.
type GovernanceInstance struct {
// The name for the GovernanceInstance.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the compartment where the GovernanceInstance resides.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the the GovernanceInstance was created in an RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the GovernanceInstance.
LifecycleState InstanceLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The unique OCID of the GovernanceInstance.
Id *string `mandatory:"false" json:"id"`
// The time the GovernanceInstance was updated in an RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The description of the GovernanceInstance.
Description *string `mandatory:"false" json:"description"`
// The licenseType being used.
LicenseType LicenseTypeEnum `mandatory:"false" json:"licenseType,omitempty"`
// The namespace for tenancy object storage.
TenancyNamespace *string `mandatory:"false" json:"tenancyNamespace"`
// The access URL of the GovernanceInstance.
InstanceUrl *string `mandatory:"false" json:"instanceUrl"`
// 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"`
// 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"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m GovernanceInstance) String() string
func (m GovernanceInstance) 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
GovernanceInstanceCollection Results of a GovernanceInstance search.
type GovernanceInstanceCollection struct {
// List of GovernanceInstances.
Items []GovernanceInstanceSummary `mandatory:"true" json:"items"`
}
func (m GovernanceInstanceCollection) String() string
func (m GovernanceInstanceCollection) 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
GovernanceInstanceConfiguration The tenancy-wide configuration for GovernanceInstances.
type GovernanceInstanceConfiguration struct {
SenderInfo *SenderConfig `mandatory:"true" json:"senderInfo"`
}
func (m GovernanceInstanceConfiguration) String() string
func (m GovernanceInstanceConfiguration) 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
GovernanceInstanceSummary The summary of an GovernanceInstance.
type GovernanceInstanceSummary struct {
// The name for the GovernanceInstance.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the compartment where the GovernanceInstance resides.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the the GovernanceInstance was created in an RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the GovernanceInstance.
LifecycleState InstanceLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The unique OCID of the GovernanceInstance.
Id *string `mandatory:"false" json:"id"`
// The description of the GovernanceInstance.
Description *string `mandatory:"false" json:"description"`
// The time the GovernanceInstance was updated in an RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The licenseType being used.
LicenseType LicenseTypeEnum `mandatory:"false" json:"licenseType,omitempty"`
// The access URL of the GovernanceInstance.
InstanceUrl *string `mandatory:"false" json:"instanceUrl"`
// 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"`
// 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"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m GovernanceInstanceSummary) String() string
func (m GovernanceInstanceSummary) 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
InstanceLifecycleStateEnum Enum with underlying type: string
type InstanceLifecycleStateEnum string
Set of constants representing the allowable values for InstanceLifecycleStateEnum
const (
InstanceLifecycleStateCreating InstanceLifecycleStateEnum = "CREATING"
InstanceLifecycleStateActive InstanceLifecycleStateEnum = "ACTIVE"
InstanceLifecycleStateDeleting InstanceLifecycleStateEnum = "DELETING"
InstanceLifecycleStateDeleted InstanceLifecycleStateEnum = "DELETED"
InstanceLifecycleStateNeedsAttention InstanceLifecycleStateEnum = "NEEDS_ATTENTION"
)
func GetInstanceLifecycleStateEnumValues() []InstanceLifecycleStateEnum
GetInstanceLifecycleStateEnumValues Enumerates the set of values for InstanceLifecycleStateEnum
func GetMappingInstanceLifecycleStateEnum(val string) (InstanceLifecycleStateEnum, bool)
GetMappingInstanceLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
LicenseTypeEnum Enum with underlying type: string
type LicenseTypeEnum string
Set of constants representing the allowable values for LicenseTypeEnum
const (
LicenseTypeNewLicense LicenseTypeEnum = "NEW_LICENSE"
LicenseTypeBringYourOwnLicense LicenseTypeEnum = "BRING_YOUR_OWN_LICENSE"
LicenseTypeAgOracleWorkloads LicenseTypeEnum = "AG_ORACLE_WORKLOADS"
LicenseTypeAgOci LicenseTypeEnum = "AG_OCI"
)
func GetLicenseTypeEnumValues() []LicenseTypeEnum
GetLicenseTypeEnumValues Enumerates the set of values for LicenseTypeEnum
func GetMappingLicenseTypeEnum(val string) (LicenseTypeEnum, bool)
GetMappingLicenseTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListGovernanceInstancesRequest wrapper for the ListGovernanceInstances operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/accessgovernancecp/ListGovernanceInstances.go.html to see an example of how to use ListGovernanceInstancesRequest.
type ListGovernanceInstancesRequest struct {
// The OCID of the compartment in which resources are listed.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The lifecycle state to filter on.
LifecycleState *string `mandatory:"false" contributesTo:"query" name:"lifecycleState"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The OCID of the GovernanceInstance
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// 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 ListGovernanceInstancesSortOrderEnum `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.
SortBy ListGovernanceInstancesSortByEnum `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 ListGovernanceInstancesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListGovernanceInstancesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListGovernanceInstancesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListGovernanceInstancesRequest) String() string
func (request ListGovernanceInstancesRequest) 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
ListGovernanceInstancesResponse wrapper for the ListGovernanceInstances operation
type ListGovernanceInstancesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of GovernanceInstanceCollection instances
GovernanceInstanceCollection `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 ListGovernanceInstancesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListGovernanceInstancesResponse) String() string
ListGovernanceInstancesSortByEnum Enum with underlying type: string
type ListGovernanceInstancesSortByEnum string
Set of constants representing the allowable values for ListGovernanceInstancesSortByEnum
const (
ListGovernanceInstancesSortByTimecreated ListGovernanceInstancesSortByEnum = "timeCreated"
ListGovernanceInstancesSortByDisplayname ListGovernanceInstancesSortByEnum = "displayName"
ListGovernanceInstancesSortByTimeupdated ListGovernanceInstancesSortByEnum = "timeUpdated"
ListGovernanceInstancesSortByLifecyclestate ListGovernanceInstancesSortByEnum = "lifecycleState"
)
func GetListGovernanceInstancesSortByEnumValues() []ListGovernanceInstancesSortByEnum
GetListGovernanceInstancesSortByEnumValues Enumerates the set of values for ListGovernanceInstancesSortByEnum
func GetMappingListGovernanceInstancesSortByEnum(val string) (ListGovernanceInstancesSortByEnum, bool)
GetMappingListGovernanceInstancesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListGovernanceInstancesSortOrderEnum Enum with underlying type: string
type ListGovernanceInstancesSortOrderEnum string
Set of constants representing the allowable values for ListGovernanceInstancesSortOrderEnum
const (
ListGovernanceInstancesSortOrderAsc ListGovernanceInstancesSortOrderEnum = "ASC"
ListGovernanceInstancesSortOrderDesc ListGovernanceInstancesSortOrderEnum = "DESC"
)
func GetListGovernanceInstancesSortOrderEnumValues() []ListGovernanceInstancesSortOrderEnum
GetListGovernanceInstancesSortOrderEnumValues Enumerates the set of values for ListGovernanceInstancesSortOrderEnum
func GetMappingListGovernanceInstancesSortOrderEnum(val string) (ListGovernanceInstancesSortOrderEnum, bool)
GetMappingListGovernanceInstancesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
SenderConfig The sender information for email notifications sent by GovernanceInstance.
type SenderConfig struct {
// The sender's displayName.
DisplayName *string `mandatory:"false" json:"displayName"`
// The sender's email.
Email *string `mandatory:"false" json:"email"`
// Whether or not the sender's email has been verified.
IsVerified *bool `mandatory:"false" json:"isVerified"`
// The time when the verify response needs to be received by.
TimeVerifyResponseExpiry *common.SDKTime `mandatory:"false" json:"timeVerifyResponseExpiry"`
// Whether the sender email has inbox configured to receive emails.
IsInboxConfigured *bool `mandatory:"false" json:"isInboxConfigured"`
}
func (m SenderConfig) String() string
func (m SenderConfig) 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
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
UpdateGovernanceInstanceConfigurationDetails The details of a tenancy-wide configuration for GovernanceInstances to be updated.
type UpdateGovernanceInstanceConfigurationDetails struct {
SenderInfo *UpdateSenderConfig `mandatory:"false" json:"senderInfo"`
}
func (m UpdateGovernanceInstanceConfigurationDetails) String() string
func (m UpdateGovernanceInstanceConfigurationDetails) 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
UpdateGovernanceInstanceConfigurationRequest wrapper for the UpdateGovernanceInstanceConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/accessgovernancecp/UpdateGovernanceInstanceConfiguration.go.html to see an example of how to use UpdateGovernanceInstanceConfigurationRequest.
type UpdateGovernanceInstanceConfigurationRequest struct {
// The details of the tenancy-wide configuration to be updated.
UpdateGovernanceInstanceConfigurationDetails `contributesTo:"body"`
// The OCID of the compartment in which resources are listed.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// 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 UpdateGovernanceInstanceConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateGovernanceInstanceConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateGovernanceInstanceConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateGovernanceInstanceConfigurationRequest) String() string
func (request UpdateGovernanceInstanceConfigurationRequest) 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
UpdateGovernanceInstanceConfigurationResponse wrapper for the UpdateGovernanceInstanceConfiguration operation
type UpdateGovernanceInstanceConfigurationResponse struct {
// The underlying http response
RawResponse *http.Response
// The GovernanceInstanceConfiguration instance
GovernanceInstanceConfiguration `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateGovernanceInstanceConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateGovernanceInstanceConfigurationResponse) String() string
UpdateGovernanceInstanceDetails The details of a GovernanceInstance to be updated.
type UpdateGovernanceInstanceDetails struct {
// The name for the GovernanceInstance.
DisplayName *string `mandatory:"false" json:"displayName"`
// The description of the GovernanceInstance.
Description *string `mandatory:"false" json:"description"`
// The licenseType being used.
LicenseType LicenseTypeEnum `mandatory:"false" json:"licenseType,omitempty"`
// 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"`
// 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"`
}
func (m UpdateGovernanceInstanceDetails) String() string
func (m UpdateGovernanceInstanceDetails) 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
UpdateGovernanceInstanceRequest wrapper for the UpdateGovernanceInstance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/accessgovernancecp/UpdateGovernanceInstance.go.html to see an example of how to use UpdateGovernanceInstanceRequest.
type UpdateGovernanceInstanceRequest struct {
// The details of the GovernanceInstance to be updated.
UpdateGovernanceInstanceDetails `contributesTo:"body"`
// The OCID of the GovernanceInstance
GovernanceInstanceId *string `mandatory:"true" contributesTo:"path" name:"governanceInstanceId"`
// 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 UpdateGovernanceInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateGovernanceInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateGovernanceInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateGovernanceInstanceRequest) String() string
func (request UpdateGovernanceInstanceRequest) 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
UpdateGovernanceInstanceResponse wrapper for the UpdateGovernanceInstance operation
type UpdateGovernanceInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// The GovernanceInstance instance
GovernanceInstance `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateGovernanceInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateGovernanceInstanceResponse) String() string
UpdateSenderConfig Update to a sender information for email notifications sent by GovernanceInstance.
type UpdateSenderConfig struct {
// The sender's email.
Email *string `mandatory:"true" json:"email"`
// Whether the sender email has inbox configured to receive emails.
IsInboxConfigured *bool `mandatory:"true" json:"isInboxConfigured"`
// The sender's displayName.
DisplayName *string `mandatory:"false" json:"displayName"`
// Whether there is a need to resend the verification email.
IsResendNotificationEmail *bool `mandatory:"false" json:"isResendNotificationEmail"`
}
func (m UpdateSenderConfig) String() string
func (m UpdateSenderConfig) 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