func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetAssignedSubscriptionEntityVersionEnumStringValues() []string
GetAssignedSubscriptionEntityVersionEnumStringValues Enumerates the set of values in String for AssignedSubscriptionEntityVersionEnum
func GetAssignedSubscriptionSummaryEntityVersionEnumStringValues() []string
GetAssignedSubscriptionSummaryEntityVersionEnumStringValues Enumerates the set of values in String for AssignedSubscriptionSummaryEntityVersionEnum
func GetBillingModelEnumStringValues() []string
GetBillingModelEnumStringValues Enumerates the set of values in String for BillingModelEnum
func GetClassicSubscriptionLifecycleStateEnumStringValues() []string
GetClassicSubscriptionLifecycleStateEnumStringValues Enumerates the set of values in String for ClassicSubscriptionLifecycleStateEnum
func GetClassicSubscriptionManagedByEnumStringValues() []string
GetClassicSubscriptionManagedByEnumStringValues Enumerates the set of values in String for ClassicSubscriptionManagedByEnum
func GetDomainGovernanceLifecycleStateEnumStringValues() []string
GetDomainGovernanceLifecycleStateEnumStringValues Enumerates the set of values in String for DomainGovernanceLifecycleStateEnum
func GetDomainLifecycleStateEnumStringValues() []string
GetDomainLifecycleStateEnumStringValues Enumerates the set of values in String for DomainLifecycleStateEnum
func GetDomainStatusEnumStringValues() []string
GetDomainStatusEnumStringValues Enumerates the set of values in String for DomainStatusEnum
func GetEntityVersionEnumStringValues() []string
GetEntityVersionEnumStringValues Enumerates the set of values in String for EntityVersionEnum
func GetGovernanceStatusEnumStringValues() []string
GetGovernanceStatusEnumStringValues Enumerates the set of values in String for GovernanceStatusEnum
func GetInvitationSubjectEnumStringValues() []string
GetInvitationSubjectEnumStringValues Enumerates the set of values in String for InvitationSubjectEnum
func GetLifecycleStateEnumStringValues() []string
GetLifecycleStateEnumStringValues Enumerates the set of values in String for LifecycleStateEnum
func GetListAssignedSubscriptionLineItemsSortByEnumStringValues() []string
GetListAssignedSubscriptionLineItemsSortByEnumStringValues Enumerates the set of values in String for ListAssignedSubscriptionLineItemsSortByEnum
func GetListAssignedSubscriptionLineItemsSortOrderEnumStringValues() []string
GetListAssignedSubscriptionLineItemsSortOrderEnumStringValues Enumerates the set of values in String for ListAssignedSubscriptionLineItemsSortOrderEnum
func GetListAssignedSubscriptionsEntityVersionEnumStringValues() []string
GetListAssignedSubscriptionsEntityVersionEnumStringValues Enumerates the set of values in String for ListAssignedSubscriptionsEntityVersionEnum
func GetListAssignedSubscriptionsSortByEnumStringValues() []string
GetListAssignedSubscriptionsSortByEnumStringValues Enumerates the set of values in String for ListAssignedSubscriptionsSortByEnum
func GetListAssignedSubscriptionsSortOrderEnumStringValues() []string
GetListAssignedSubscriptionsSortOrderEnumStringValues Enumerates the set of values in String for ListAssignedSubscriptionsSortOrderEnum
func GetListDomainGovernancesLifecycleStateEnumStringValues() []string
GetListDomainGovernancesLifecycleStateEnumStringValues Enumerates the set of values in String for ListDomainGovernancesLifecycleStateEnum
func GetListDomainGovernancesSortByEnumStringValues() []string
GetListDomainGovernancesSortByEnumStringValues Enumerates the set of values in String for ListDomainGovernancesSortByEnum
func GetListDomainGovernancesSortOrderEnumStringValues() []string
GetListDomainGovernancesSortOrderEnumStringValues Enumerates the set of values in String for ListDomainGovernancesSortOrderEnum
func GetListDomainsLifecycleStateEnumStringValues() []string
GetListDomainsLifecycleStateEnumStringValues Enumerates the set of values in String for ListDomainsLifecycleStateEnum
func GetListDomainsSortByEnumStringValues() []string
GetListDomainsSortByEnumStringValues Enumerates the set of values in String for ListDomainsSortByEnum
func GetListDomainsSortOrderEnumStringValues() []string
GetListDomainsSortOrderEnumStringValues Enumerates the set of values in String for ListDomainsSortOrderEnum
func GetListLinksLifecycleStateEnumStringValues() []string
GetListLinksLifecycleStateEnumStringValues Enumerates the set of values in String for ListLinksLifecycleStateEnum
func GetListLinksSortOrderEnumStringValues() []string
GetListLinksSortOrderEnumStringValues Enumerates the set of values in String for ListLinksSortOrderEnum
func GetListRecipientInvitationsLifecycleStateEnumStringValues() []string
GetListRecipientInvitationsLifecycleStateEnumStringValues Enumerates the set of values in String for ListRecipientInvitationsLifecycleStateEnum
func GetListRecipientInvitationsStatusEnumStringValues() []string
GetListRecipientInvitationsStatusEnumStringValues Enumerates the set of values in String for ListRecipientInvitationsStatusEnum
func GetListSenderInvitationsLifecycleStateEnumStringValues() []string
GetListSenderInvitationsLifecycleStateEnumStringValues Enumerates the set of values in String for ListSenderInvitationsLifecycleStateEnum
func GetListSenderInvitationsSortByEnumStringValues() []string
GetListSenderInvitationsSortByEnumStringValues Enumerates the set of values in String for ListSenderInvitationsSortByEnum
func GetListSenderInvitationsSortOrderEnumStringValues() []string
GetListSenderInvitationsSortOrderEnumStringValues Enumerates the set of values in String for ListSenderInvitationsSortOrderEnum
func GetListSenderInvitationsStatusEnumStringValues() []string
GetListSenderInvitationsStatusEnumStringValues Enumerates the set of values in String for ListSenderInvitationsStatusEnum
func GetListSubscriptionLineItemsSortByEnumStringValues() []string
GetListSubscriptionLineItemsSortByEnumStringValues Enumerates the set of values in String for ListSubscriptionLineItemsSortByEnum
func GetListSubscriptionLineItemsSortOrderEnumStringValues() []string
GetListSubscriptionLineItemsSortOrderEnumStringValues Enumerates the set of values in String for ListSubscriptionLineItemsSortOrderEnum
func GetListSubscriptionMappingsSortByEnumStringValues() []string
GetListSubscriptionMappingsSortByEnumStringValues Enumerates the set of values in String for ListSubscriptionMappingsSortByEnum
func GetListSubscriptionMappingsSortOrderEnumStringValues() []string
GetListSubscriptionMappingsSortOrderEnumStringValues Enumerates the set of values in String for ListSubscriptionMappingsSortOrderEnum
func GetListSubscriptionsEntityVersionEnumStringValues() []string
GetListSubscriptionsEntityVersionEnumStringValues Enumerates the set of values in String for ListSubscriptionsEntityVersionEnum
func GetListSubscriptionsSortByEnumStringValues() []string
GetListSubscriptionsSortByEnumStringValues Enumerates the set of values in String for ListSubscriptionsSortByEnum
func GetListSubscriptionsSortOrderEnumStringValues() []string
GetListSubscriptionsSortOrderEnumStringValues Enumerates the set of values in String for ListSubscriptionsSortOrderEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
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 GetOrganizationLifecycleStateEnumStringValues() []string
GetOrganizationLifecycleStateEnumStringValues Enumerates the set of values in String for OrganizationLifecycleStateEnum
func GetOrganizationTenancyLifecycleStateEnumStringValues() []string
GetOrganizationTenancyLifecycleStateEnumStringValues Enumerates the set of values in String for OrganizationTenancyLifecycleStateEnum
func GetOrganizationTenancyRoleEnumStringValues() []string
GetOrganizationTenancyRoleEnumStringValues Enumerates the set of values in String for OrganizationTenancyRoleEnum
func GetPromotionStatusEnumStringValues() []string
GetPromotionStatusEnumStringValues Enumerates the set of values in String for PromotionStatusEnum
func GetRecipientInvitationStatusEnumStringValues() []string
GetRecipientInvitationStatusEnumStringValues Enumerates the set of values in String for RecipientInvitationStatusEnum
func GetSenderInvitationStatusEnumStringValues() []string
GetSenderInvitationStatusEnumStringValues Enumerates the set of values in String for SenderInvitationStatusEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetSubscriptionEntityVersionEnumStringValues() []string
GetSubscriptionEntityVersionEnumStringValues Enumerates the set of values in String for SubscriptionEntityVersionEnum
func GetSubscriptionLifecycleStateEnumStringValues() []string
GetSubscriptionLifecycleStateEnumStringValues Enumerates the set of values in String for SubscriptionLifecycleStateEnum
func GetSubscriptionMappingLifecycleStateEnumStringValues() []string
GetSubscriptionMappingLifecycleStateEnumStringValues Enumerates the set of values in String for SubscriptionMappingLifecycleStateEnum
func GetSubscriptionSummaryEntityVersionEnumStringValues() []string
GetSubscriptionSummaryEntityVersionEnumStringValues Enumerates the set of values in String for SubscriptionSummaryEntityVersionEnum
AcceptRecipientInvitationRequest wrapper for the AcceptRecipientInvitation operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/AcceptRecipientInvitation.go.html to see an example of how to use AcceptRecipientInvitationRequest.
type AcceptRecipientInvitationRequest struct {
// OCID of recipient invitation to accept.
RecipientInvitationId *string `mandatory:"true" contributesTo:"path" name:"recipientInvitationId"`
// 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
// will 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 AcceptRecipientInvitationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AcceptRecipientInvitationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AcceptRecipientInvitationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AcceptRecipientInvitationRequest) String() string
func (request AcceptRecipientInvitationRequest) 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
AcceptRecipientInvitationResponse wrapper for the AcceptRecipientInvitation operation
type AcceptRecipientInvitationResponse 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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response AcceptRecipientInvitationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AcceptRecipientInvitationResponse) String() string
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"
)
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
ActivateOrderDetails The parameters for activating an order subscription in a tenancy.
type ActivateOrderDetails struct {
// Tenant ID to activate the order.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ActivateOrderDetails) String() string
func (m ActivateOrderDetails) 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
ActivateOrderRequest wrapper for the ActivateOrder operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ActivateOrder.go.html to see an example of how to use ActivateOrderRequest.
type ActivateOrderRequest struct {
// The information needed to activate an order in a tenancy.
ActivateOrderDetails `contributesTo:"body"`
// Activation token containing an order ID. A JWT RFC 7519-formatted string.
ActivationToken *string `mandatory:"true" contributesTo:"path" name:"activationToken"`
// 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
// will 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 ActivateOrderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ActivateOrderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ActivateOrderRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ActivateOrderRequest) String() string
func (request ActivateOrderRequest) 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
ActivateOrderResponse wrapper for the ActivateOrder operation
type ActivateOrderResponse 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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response ActivateOrderResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ActivateOrderResponse) String() string
AddGovernanceRequest wrapper for the AddGovernance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/AddGovernance.go.html to see an example of how to use AddGovernanceRequest.
type AddGovernanceRequest struct {
// OCID of the organization.
OrganizationId *string `mandatory:"true" contributesTo:"path" name:"organizationId"`
// OCID of tenancy that is opting in to governance rules.
OrganizationTenancyId *string `mandatory:"true" contributesTo:"path" name:"organizationTenancyId"`
// 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
// will 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 AddGovernanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddGovernanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddGovernanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddGovernanceRequest) String() string
func (request AddGovernanceRequest) 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
AddGovernanceResponse wrapper for the AddGovernance operation
type AddGovernanceResponse 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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response AddGovernanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddGovernanceResponse) String() string
AdditionalAssignedRegionCollection List of regions assignments of a subscription
type AdditionalAssignedRegionCollection struct {
// Array containing all regions in region assignments list of a subscription
Items []string `mandatory:"true" json:"items"`
}
func (m AdditionalAssignedRegionCollection) String() string
func (m AdditionalAssignedRegionCollection) 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
ApproveOrganizationTenancyForTransferRequest wrapper for the ApproveOrganizationTenancyForTransfer operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ApproveOrganizationTenancyForTransfer.go.html to see an example of how to use ApproveOrganizationTenancyForTransferRequest.
type ApproveOrganizationTenancyForTransferRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// OCID of the child tenancy.
OrganizationTenancyId *string `mandatory:"true" contributesTo:"path" name:"organizationTenancyId"`
// 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
// will 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 ApproveOrganizationTenancyForTransferRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ApproveOrganizationTenancyForTransferRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ApproveOrganizationTenancyForTransferRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ApproveOrganizationTenancyForTransferRequest) String() string
func (request ApproveOrganizationTenancyForTransferRequest) 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
ApproveOrganizationTenancyForTransferResponse wrapper for the ApproveOrganizationTenancyForTransfer operation
type ApproveOrganizationTenancyForTransferResponse struct {
// The underlying http response
RawResponse *http.Response
// The OrganizationTenancy instance
OrganizationTenancy `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response ApproveOrganizationTenancyForTransferResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ApproveOrganizationTenancyForTransferResponse) String() string
AssignedSubscription Assigned subscription type, which carries shared properties for any assigned subscription version.
type AssignedSubscription interface {
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the subscription.
GetId() *string
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the owning compartment. Always a tenancy OCID.
GetCompartmentId() *string
// The type of subscription, such as 'UCM', 'SAAS', 'ERP', 'CRM'.
GetServiceName() *string
// The date and time of creation, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
GetTimeCreated() *common.SDKTime
// The date and time of update, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
GetTimeUpdated() *common.SDKTime
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
}
AssignedSubscriptionCollection Collection of assigned subscription summaries.
type AssignedSubscriptionCollection struct {
// Array containing assigned subscription summary items.
Items []AssignedSubscriptionSummary `mandatory:"true" json:"items"`
}
func (m AssignedSubscriptionCollection) String() string
func (m *AssignedSubscriptionCollection) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m AssignedSubscriptionCollection) 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
AssignedSubscriptionEntityVersionEnum Enum with underlying type: string
type AssignedSubscriptionEntityVersionEnum string
Set of constants representing the allowable values for AssignedSubscriptionEntityVersionEnum
const (
AssignedSubscriptionEntityVersionV1 AssignedSubscriptionEntityVersionEnum = "V1"
AssignedSubscriptionEntityVersionV2 AssignedSubscriptionEntityVersionEnum = "V2"
)
func GetAssignedSubscriptionEntityVersionEnumValues() []AssignedSubscriptionEntityVersionEnum
GetAssignedSubscriptionEntityVersionEnumValues Enumerates the set of values for AssignedSubscriptionEntityVersionEnum
func GetMappingAssignedSubscriptionEntityVersionEnum(val string) (AssignedSubscriptionEntityVersionEnum, bool)
GetMappingAssignedSubscriptionEntityVersionEnum performs case Insensitive comparison on enum value and return the desired enum
AssignedSubscriptionLineItemCollection Collection of line item summaries in an assigned subscription.
type AssignedSubscriptionLineItemCollection struct {
// Array containing line item summaries in an assigned subscription.
Items []AssignedSubscriptionLineItemSummary `mandatory:"true" json:"items"`
}
func (m AssignedSubscriptionLineItemCollection) String() string
func (m AssignedSubscriptionLineItemCollection) 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
AssignedSubscriptionLineItemSummary Summary of the line item in an assigned subscription.
type AssignedSubscriptionLineItemSummary struct {
// Subscription line item identifier.
Id *string `mandatory:"true" json:"id"`
// Product code.
ProductCode *string `mandatory:"true" json:"productCode"`
// Product number.
Quantity *float32 `mandatory:"true" json:"quantity"`
// Billing model supported by the associated line item.
BillingModel BillingModelEnum `mandatory:"true" json:"billingModel"`
// The time the subscription item and associated products should start. An RFC 3339 formatted date and time string.
TimeStarted *common.SDKTime `mandatory:"true" json:"timeStarted"`
// The time the subscription item and associated products should end. An RFC 3339 formatted date and time string.
TimeEnded *common.SDKTime `mandatory:"true" json:"timeEnded"`
// 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 AssignedSubscriptionLineItemSummary) String() string
func (m AssignedSubscriptionLineItemSummary) 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
AssignedSubscriptionSummary Assigned subscription summary type, which carries shared properties for any assigned subscription summary version.
type AssignedSubscriptionSummary interface {
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the subscription.
GetId() *string
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the owning compartment. Always a tenancy OCID.
GetCompartmentId() *string
// The type of subscription, such as 'UCM', 'SAAS', 'ERP', 'CRM'.
GetServiceName() *string
// The date and time of creation, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
GetTimeCreated() *common.SDKTime
// The date and time of update, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
GetTimeUpdated() *common.SDKTime
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
GetSystemTags() map[string]map[string]interface{}
}
AssignedSubscriptionSummaryEntityVersionEnum Enum with underlying type: string
type AssignedSubscriptionSummaryEntityVersionEnum string
Set of constants representing the allowable values for AssignedSubscriptionSummaryEntityVersionEnum
const (
AssignedSubscriptionSummaryEntityVersionV1 AssignedSubscriptionSummaryEntityVersionEnum = "V1"
AssignedSubscriptionSummaryEntityVersionV2 AssignedSubscriptionSummaryEntityVersionEnum = "V2"
)
func GetAssignedSubscriptionSummaryEntityVersionEnumValues() []AssignedSubscriptionSummaryEntityVersionEnum
GetAssignedSubscriptionSummaryEntityVersionEnumValues Enumerates the set of values for AssignedSubscriptionSummaryEntityVersionEnum
func GetMappingAssignedSubscriptionSummaryEntityVersionEnum(val string) (AssignedSubscriptionSummaryEntityVersionEnum, bool)
GetMappingAssignedSubscriptionSummaryEntityVersionEnum performs case Insensitive comparison on enum value and return the desired enum
AvailableRegionCollection List of available regions.
type AvailableRegionCollection struct {
// Array containing available region items.
Items []AvailableRegionSummary `mandatory:"true" json:"items"`
}
func (m AvailableRegionCollection) String() string
func (m AvailableRegionCollection) 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
AvailableRegionSummary The summary of region availability for a subscription.
type AvailableRegionSummary struct {
// Region availability for the subscription.
RegionName *string `mandatory:"true" json:"regionName"`
// 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 AvailableRegionSummary) String() string
func (m AvailableRegionSummary) 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
BillingModelEnum Enum with underlying type: string
type BillingModelEnum string
Set of constants representing the allowable values for BillingModelEnum
const (
BillingModelCommitment BillingModelEnum = "COMMITMENT"
BillingModelPaygo BillingModelEnum = "PAYGO"
BillingModelPromotion BillingModelEnum = "PROMOTION"
)
func GetBillingModelEnumValues() []BillingModelEnum
GetBillingModelEnumValues Enumerates the set of values for BillingModelEnum
func GetMappingBillingModelEnum(val string) (BillingModelEnum, bool)
GetMappingBillingModelEnum performs case Insensitive comparison on enum value and return the desired enum
CancelSenderInvitationRequest wrapper for the CancelSenderInvitation operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/CancelSenderInvitation.go.html to see an example of how to use CancelSenderInvitationRequest.
type CancelSenderInvitationRequest struct {
// OCID of the sender invitation to cancel.
SenderInvitationId *string `mandatory:"true" contributesTo:"path" name:"senderInvitationId"`
// 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
// will 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 CancelSenderInvitationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelSenderInvitationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelSenderInvitationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelSenderInvitationRequest) String() string
func (request CancelSenderInvitationRequest) 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
CancelSenderInvitationResponse wrapper for the CancelSenderInvitation operation
type CancelSenderInvitationResponse 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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response CancelSenderInvitationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelSenderInvitationResponse) String() string
ClassicAssignedSubscription Assigned subscription information.
type ClassicAssignedSubscription struct {
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the subscription.
Id *string `mandatory:"true" json:"id"`
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the owning compartment. Always a tenancy OCID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The type of subscription, such as 'UCM', 'SAAS', 'ERP', 'CRM'.
ServiceName *string `mandatory:"true" json:"serviceName"`
// The date and time of creation, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time of update, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"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"`
// Subscription ID.
ClassicSubscriptionId *string `mandatory:"true" json:"classicSubscriptionId"`
// Specifies whether or not the subscription is legacy.
IsClassicSubscription *bool `mandatory:"false" json:"isClassicSubscription"`
// Region for the subscription.
RegionAssignment *string `mandatory:"false" json:"regionAssignment"`
// List of SKUs linked to the subscription.
Skus []SubscriptionSku `mandatory:"false" json:"skus"`
// List of subscription order OCIDs that contributed to this subscription.
OrderIds []string `mandatory:"false" json:"orderIds"`
// Specifies any program that is associated with the subscription.
ProgramType *string `mandatory:"false" json:"programType"`
// The country code for the customer associated with the subscription.
CustomerCountryCode *string `mandatory:"false" json:"customerCountryCode"`
// The currency code for the customer associated with the subscription.
CloudAmountCurrency *string `mandatory:"false" json:"cloudAmountCurrency"`
// Customer service identifier for the customer associated with the subscription.
CsiNumber *string `mandatory:"false" json:"csiNumber"`
// Tier for the subscription, whether a free promotion subscription or a paid subscription.
SubscriptionTier *string `mandatory:"false" json:"subscriptionTier"`
// Specifies whether or not the subscription is a government subscription.
IsGovernmentSubscription *bool `mandatory:"false" json:"isGovernmentSubscription"`
// List of promotions related to the subscription.
Promotion []Promotion `mandatory:"false" json:"promotion"`
// Purchase entitlement ID associated with the subscription.
PurchaseEntitlementId *string `mandatory:"false" json:"purchaseEntitlementId"`
// Subscription start time.
StartDate *common.SDKTime `mandatory:"false" json:"startDate"`
// Subscription end time.
EndDate *common.SDKTime `mandatory:"false" json:"endDate"`
// Lifecycle state of the subscription.
LifecycleState ClassicSubscriptionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Service or component which is used to provision and manage the subscription.
ManagedBy ClassicSubscriptionManagedByEnum `mandatory:"false" json:"managedBy,omitempty"`
}
func (m ClassicAssignedSubscription) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m ClassicAssignedSubscription) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m ClassicAssignedSubscription) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m ClassicAssignedSubscription) GetId() *string
GetId returns Id
func (m ClassicAssignedSubscription) GetServiceName() *string
GetServiceName returns ServiceName
func (m ClassicAssignedSubscription) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m ClassicAssignedSubscription) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m ClassicAssignedSubscription) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ClassicAssignedSubscription) String() string
func (m ClassicAssignedSubscription) 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
ClassicAssignedSubscriptionSummary Summary of assigned subscription information.
type ClassicAssignedSubscriptionSummary struct {
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the subscription.
Id *string `mandatory:"true" json:"id"`
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the owning compartment. Always a tenancy OCID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The type of subscription, such as 'UCM', 'SAAS', 'ERP', 'CRM'.
ServiceName *string `mandatory:"true" json:"serviceName"`
// The date and time of creation, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time of update, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"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"`
// Subscription ID.
ClassicSubscriptionId *string `mandatory:"true" json:"classicSubscriptionId"`
// 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"`
// Specifies whether or not the subscription is legacy.
IsClassicSubscription *bool `mandatory:"false" json:"isClassicSubscription"`
// Region for the subscription.
RegionAssignment *string `mandatory:"false" json:"regionAssignment"`
// Subscription start time.
StartDate *common.SDKTime `mandatory:"false" json:"startDate"`
// Subscription end time.
EndDate *common.SDKTime `mandatory:"false" json:"endDate"`
// Customer service identifier for the customer associated with the subscription.
CsiNumber *string `mandatory:"false" json:"csiNumber"`
// Lifecycle state of the subscription.
LifecycleState ClassicSubscriptionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Service or component which is used to provision and manage the subscription.
ManagedBy ClassicSubscriptionManagedByEnum `mandatory:"false" json:"managedBy,omitempty"`
}
func (m ClassicAssignedSubscriptionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m ClassicAssignedSubscriptionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m ClassicAssignedSubscriptionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m ClassicAssignedSubscriptionSummary) GetId() *string
GetId returns Id
func (m ClassicAssignedSubscriptionSummary) GetServiceName() *string
GetServiceName returns ServiceName
func (m ClassicAssignedSubscriptionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m ClassicAssignedSubscriptionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m ClassicAssignedSubscriptionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m ClassicAssignedSubscriptionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ClassicAssignedSubscriptionSummary) String() string
func (m ClassicAssignedSubscriptionSummary) 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
ClassicSubscription Subscription information for the compartmentId. Only root compartments are allowed.
type ClassicSubscription struct {
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the subscription.
Id *string `mandatory:"true" json:"id"`
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the owning compartment. Always a tenancy OCID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The type of subscription, such as 'UCM', 'SAAS', 'ERP', 'CRM'.
ServiceName *string `mandatory:"true" json:"serviceName"`
// The date and time of creation, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time of update, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"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"`
// Classic subscription ID.
ClassicSubscriptionId *string `mandatory:"true" json:"classicSubscriptionId"`
// Specifies whether or not the subscription is from classic systems.
IsClassicSubscription *bool `mandatory:"false" json:"isClassicSubscription"`
// The pay model of the subscription, such as 'Pay as you go' or 'Monthly'.
PaymentModel *string `mandatory:"false" json:"paymentModel"`
// Region for the subscription.
RegionAssignment *string `mandatory:"false" json:"regionAssignment"`
// List of SKUs linked to this subscription.
Skus []SubscriptionSku `mandatory:"false" json:"skus"`
// Specifies any program that is associated with the subscription.
ProgramType *string `mandatory:"false" json:"programType"`
// The country code for the customer associated with the subscription.
CustomerCountryCode *string `mandatory:"false" json:"customerCountryCode"`
// The currency code for the customer associated with the subscription.
CloudAmountCurrency *string `mandatory:"false" json:"cloudAmountCurrency"`
// Customer service identifier for the customer associated with the subscription.
CsiNumber *string `mandatory:"false" json:"csiNumber"`
// Tier for the subscription, whether a free promotion subscription or a paid subscription.
SubscriptionTier *string `mandatory:"false" json:"subscriptionTier"`
// Specifies whether or not the subscription is a government subscription.
IsGovernmentSubscription *bool `mandatory:"false" json:"isGovernmentSubscription"`
// List of promotions related to the subscription.
Promotion []Promotion `mandatory:"false" json:"promotion"`
// Purchase entitlement ID associated with the subscription.
PurchaseEntitlementId *string `mandatory:"false" json:"purchaseEntitlementId"`
// Subscription start time.
StartDate *common.SDKTime `mandatory:"false" json:"startDate"`
// Subscription end time.
EndDate *common.SDKTime `mandatory:"false" json:"endDate"`
// This list will contain up to 5 regions where the subscription has a physical presence
RegionAssignments []string `mandatory:"false" json:"regionAssignments"`
// Lifecycle state of the subscription.
LifecycleState ClassicSubscriptionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
func (m ClassicSubscription) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m ClassicSubscription) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m ClassicSubscription) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m ClassicSubscription) GetId() *string
GetId returns Id
func (m ClassicSubscription) GetServiceName() *string
GetServiceName returns ServiceName
func (m ClassicSubscription) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m ClassicSubscription) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m ClassicSubscription) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ClassicSubscription) String() string
func (m ClassicSubscription) 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
ClassicSubscriptionLifecycleStateEnum Enum with underlying type: string
type ClassicSubscriptionLifecycleStateEnum string
Set of constants representing the allowable values for ClassicSubscriptionLifecycleStateEnum
const (
ClassicSubscriptionLifecycleStateCreating ClassicSubscriptionLifecycleStateEnum = "CREATING"
ClassicSubscriptionLifecycleStateActive ClassicSubscriptionLifecycleStateEnum = "ACTIVE"
ClassicSubscriptionLifecycleStateInactive ClassicSubscriptionLifecycleStateEnum = "INACTIVE"
ClassicSubscriptionLifecycleStateUpdating ClassicSubscriptionLifecycleStateEnum = "UPDATING"
ClassicSubscriptionLifecycleStateDeleting ClassicSubscriptionLifecycleStateEnum = "DELETING"
ClassicSubscriptionLifecycleStateDeleted ClassicSubscriptionLifecycleStateEnum = "DELETED"
ClassicSubscriptionLifecycleStateFailed ClassicSubscriptionLifecycleStateEnum = "FAILED"
)
func GetClassicSubscriptionLifecycleStateEnumValues() []ClassicSubscriptionLifecycleStateEnum
GetClassicSubscriptionLifecycleStateEnumValues Enumerates the set of values for ClassicSubscriptionLifecycleStateEnum
func GetMappingClassicSubscriptionLifecycleStateEnum(val string) (ClassicSubscriptionLifecycleStateEnum, bool)
GetMappingClassicSubscriptionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ClassicSubscriptionManagedByEnum Enum with underlying type: string
type ClassicSubscriptionManagedByEnum string
Set of constants representing the allowable values for ClassicSubscriptionManagedByEnum
const (
ClassicSubscriptionManagedByAppsmanager ClassicSubscriptionManagedByEnum = "APPSMANAGER"
ClassicSubscriptionManagedByServicemanagerproxy ClassicSubscriptionManagedByEnum = "SERVICEMANAGERPROXY"
ClassicSubscriptionManagedByFusionapps ClassicSubscriptionManagedByEnum = "FUSIONAPPS"
ClassicSubscriptionManagedByMyservices ClassicSubscriptionManagedByEnum = "MYSERVICES"
)
func GetClassicSubscriptionManagedByEnumValues() []ClassicSubscriptionManagedByEnum
GetClassicSubscriptionManagedByEnumValues Enumerates the set of values for ClassicSubscriptionManagedByEnum
func GetMappingClassicSubscriptionManagedByEnum(val string) (ClassicSubscriptionManagedByEnum, bool)
GetMappingClassicSubscriptionManagedByEnum performs case Insensitive comparison on enum value and return the desired enum
ClassicSubscriptionSummary Summary of subscription.
type ClassicSubscriptionSummary struct {
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the subscription.
Id *string `mandatory:"true" json:"id"`
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the owning compartment. Always a tenancy OCID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The type of subscription, such as 'CLOUDCM', 'AUTOANALYTICS', 'ERP', 'CRM'.
ServiceName *string `mandatory:"true" json:"serviceName"`
// The date and time of creation, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time of update, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"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"`
// Classic subscription ID.
ClassicSubscriptionId *string `mandatory:"true" json:"classicSubscriptionId"`
// 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"`
// Specifies whether or not the subscription is from classic systems.
IsClassicSubscription *bool `mandatory:"false" json:"isClassicSubscription"`
// The pay model of the subscription, such as 'Pay as you go' or 'Monthly'.
PaymentModel *string `mandatory:"false" json:"paymentModel"`
// Region for the subscription.
RegionAssignment *string `mandatory:"false" json:"regionAssignment"`
// Subscription start time.
StartDate *common.SDKTime `mandatory:"false" json:"startDate"`
// Subscription end time.
EndDate *common.SDKTime `mandatory:"false" json:"endDate"`
// Lifecycle state of the subscription.
LifecycleState ClassicSubscriptionLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}
func (m ClassicSubscriptionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m ClassicSubscriptionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m ClassicSubscriptionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m ClassicSubscriptionSummary) GetId() *string
GetId returns Id
func (m ClassicSubscriptionSummary) GetServiceName() *string
GetServiceName returns ServiceName
func (m ClassicSubscriptionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m ClassicSubscriptionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m ClassicSubscriptionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m ClassicSubscriptionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ClassicSubscriptionSummary) String() string
func (m ClassicSubscriptionSummary) 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
CloudAssignedSubscription Assigned subscription information.
type CloudAssignedSubscription struct {
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the subscription.
Id *string `mandatory:"true" json:"id"`
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the owning compartment. Always a tenancy OCID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The type of subscription, such as 'UCM', 'SAAS', 'ERP', 'CRM'.
ServiceName *string `mandatory:"true" json:"serviceName"`
// The date and time of creation, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time of update, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"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"`
// Unique Oracle Cloud Subscriptions identifier that is immutable on creation.
SubscriptionNumber *string `mandatory:"true" json:"subscriptionNumber"`
// Currency code. For example USD, MXN.
CurrencyCode *string `mandatory:"true" json:"currencyCode"`
// Lifecycle state of the subscription.
LifecycleState SubscriptionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
func (m CloudAssignedSubscription) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CloudAssignedSubscription) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CloudAssignedSubscription) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CloudAssignedSubscription) GetId() *string
GetId returns Id
func (m CloudAssignedSubscription) GetServiceName() *string
GetServiceName returns ServiceName
func (m CloudAssignedSubscription) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m CloudAssignedSubscription) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m CloudAssignedSubscription) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CloudAssignedSubscription) String() string
func (m CloudAssignedSubscription) 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
CloudAssignedSubscriptionSummary Summary of assigned subscription information.
type CloudAssignedSubscriptionSummary struct {
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the subscription.
Id *string `mandatory:"true" json:"id"`
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the owning compartment. Always a tenancy OCID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The type of subscription, such as 'UCM', 'SAAS', 'ERP', 'CRM'.
ServiceName *string `mandatory:"true" json:"serviceName"`
// The date and time of creation, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time of update, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"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"`
// Unique Oracle Cloud Subscriptions identifier that is immutable on creation.
SubscriptionNumber *string `mandatory:"true" json:"subscriptionNumber"`
// Currency code. For example USD, MXN.
CurrencyCode *string `mandatory:"true" json:"currencyCode"`
// 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"`
// Lifecycle state of the subscription.
LifecycleState SubscriptionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
func (m CloudAssignedSubscriptionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CloudAssignedSubscriptionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CloudAssignedSubscriptionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CloudAssignedSubscriptionSummary) GetId() *string
GetId returns Id
func (m CloudAssignedSubscriptionSummary) GetServiceName() *string
GetServiceName returns ServiceName
func (m CloudAssignedSubscriptionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m CloudAssignedSubscriptionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m CloudAssignedSubscriptionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m CloudAssignedSubscriptionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CloudAssignedSubscriptionSummary) String() string
func (m CloudAssignedSubscriptionSummary) 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
CloudSubscription Subscription information for compartment ID. Only root compartments are allowed.
type CloudSubscription struct {
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the subscription.
Id *string `mandatory:"true" json:"id"`
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the owning compartment. Always a tenancy OCID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The type of subscription, such as 'UCM', 'SAAS', 'ERP', 'CRM'.
ServiceName *string `mandatory:"true" json:"serviceName"`
// The date and time of creation, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time of update, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"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"`
// Unique Oracle Cloud Subscriptions identifier that is immutable on creation.
SubscriptionNumber *string `mandatory:"true" json:"subscriptionNumber"`
// Currency code. For example USD, MXN.
CurrencyCode *string `mandatory:"true" json:"currencyCode"`
// Lifecycle state of the subscription.
LifecycleState SubscriptionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
func (m CloudSubscription) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CloudSubscription) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CloudSubscription) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CloudSubscription) GetId() *string
GetId returns Id
func (m CloudSubscription) GetServiceName() *string
GetServiceName returns ServiceName
func (m CloudSubscription) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m CloudSubscription) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m CloudSubscription) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CloudSubscription) String() string
func (m CloudSubscription) 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
CloudSubscriptionSummary Summary of subscription.
type CloudSubscriptionSummary struct {
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the subscription.
Id *string `mandatory:"true" json:"id"`
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the owning compartment. Always a tenancy OCID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The type of subscription, such as 'CLOUDCM', 'AUTOANALYTICS', 'ERP', 'CRM'.
ServiceName *string `mandatory:"true" json:"serviceName"`
// The date and time of creation, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time of update, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"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"`
// Unique Oracle Cloud Subscriptions identifier that is immutable on creation.
SubscriptionNumber *string `mandatory:"true" json:"subscriptionNumber"`
// Currency code. For example USD, MXN.
CurrencyCode *string `mandatory:"true" json:"currencyCode"`
// 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"`
// Lifecycle state of the subscription.
LifecycleState SubscriptionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
func (m CloudSubscriptionSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CloudSubscriptionSummary) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CloudSubscriptionSummary) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CloudSubscriptionSummary) GetId() *string
GetId returns Id
func (m CloudSubscriptionSummary) GetServiceName() *string
GetServiceName returns ServiceName
func (m CloudSubscriptionSummary) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m CloudSubscriptionSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m CloudSubscriptionSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m CloudSubscriptionSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CloudSubscriptionSummary) String() string
func (m CloudSubscriptionSummary) 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
CreateChildTenancyDetails The parameters for creating a child tenancy.
type CreateChildTenancyDetails struct {
// The tenancy ID of the parent tenancy.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The tenancy name to use for the child tenancy.
TenancyName *string `mandatory:"true" json:"tenancyName"`
// The home region to use for the child tenancy. This must be a region where the parent tenancy is subscribed.
HomeRegion *string `mandatory:"true" json:"homeRegion"`
// Email address of the child tenancy administrator.
AdminEmail *string `mandatory:"true" json:"adminEmail"`
// The name to use for the administrator policy in the child tenancy. Must contain only letters and underscores.
PolicyName *string `mandatory:"false" json:"policyName"`
// The governance status of the child tenancy.
GovernanceStatus GovernanceStatusEnum `mandatory:"false" json:"governanceStatus,omitempty"`
// OCID of the subscription that needs to be assigned to the child tenancy.
SubscriptionId *string `mandatory:"false" json:"subscriptionId"`
}
func (m CreateChildTenancyDetails) String() string
func (m CreateChildTenancyDetails) 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
CreateChildTenancyRequest wrapper for the CreateChildTenancy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/CreateChildTenancy.go.html to see an example of how to use CreateChildTenancyRequest.
type CreateChildTenancyRequest struct {
// Parameters to create a child tenancy.
CreateChildTenancyDetails `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
// will 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 CreateChildTenancyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateChildTenancyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateChildTenancyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateChildTenancyRequest) String() string
func (request CreateChildTenancyRequest) 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
CreateChildTenancyResponse wrapper for the CreateChildTenancy operation
type CreateChildTenancyResponse 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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response CreateChildTenancyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateChildTenancyResponse) String() string
CreateDomainDetails The parameters for creating a domain.
type CreateDomainDetails struct {
// OCID of the tenancy.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The domain name.
DomainName *string `mandatory:"true" json:"domainName"`
// Email address to be used to notify the user, and that the ONS subscription will be created with.
SubscriptionEmail *string `mandatory:"false" json:"subscriptionEmail"`
// Indicates whether governance should be enabled for this domain. Defaults to false.
IsGovernanceEnabled *bool `mandatory:"false" json:"isGovernanceEnabled"`
// 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 CreateDomainDetails) String() string
func (m CreateDomainDetails) 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
CreateDomainGovernanceDetails The parameters for creating a domain governance entity.
type CreateDomainGovernanceDetails struct {
// OCID of the tenancy.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// OCID of the domain.
DomainId *string `mandatory:"true" json:"domainId"`
// Email address to be used to notify the user, and that the ONS subscription will be created with.
SubscriptionEmail *string `mandatory:"true" json:"subscriptionEmail"`
// The ONS topic associated with this domain governance entity.
OnsTopicId *string `mandatory:"true" json:"onsTopicId"`
// The ONS subscription associated with this domain governance entity.
OnsSubscriptionId *string `mandatory:"true" json:"onsSubscriptionId"`
// 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 CreateDomainGovernanceDetails) String() string
func (m CreateDomainGovernanceDetails) 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
CreateDomainGovernanceRequest wrapper for the CreateDomainGovernance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/CreateDomainGovernance.go.html to see an example of how to use CreateDomainGovernanceRequest.
type CreateDomainGovernanceRequest struct {
// Parameters for adding domain governance to a claimed domain.
CreateDomainGovernanceDetails `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
// will 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 CreateDomainGovernanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDomainGovernanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDomainGovernanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDomainGovernanceRequest) String() string
func (request CreateDomainGovernanceRequest) 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
CreateDomainGovernanceResponse wrapper for the CreateDomainGovernance operation
type CreateDomainGovernanceResponse struct {
// The underlying http response
RawResponse *http.Response
// The DomainGovernance instance
DomainGovernance `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateDomainGovernanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDomainGovernanceResponse) String() string
CreateDomainRequest wrapper for the CreateDomain operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/CreateDomain.go.html to see an example of how to use CreateDomainRequest.
type CreateDomainRequest struct {
// Parameters for domain creation.
CreateDomainDetails `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
// will 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 CreateDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDomainRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDomainRequest) String() string
func (request CreateDomainRequest) 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
CreateDomainResponse wrapper for the CreateDomain operation
type CreateDomainResponse struct {
// The underlying http response
RawResponse *http.Response
// The Domain instance
Domain `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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateDomainResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDomainResponse) String() string
CreateSenderInvitationDetails The parameters for creating a sender invitation.
type CreateSenderInvitationDetails struct {
// OCID of the sender tenancy.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// OCID of the recipient tenancy.
RecipientTenancyId *string `mandatory:"true" json:"recipientTenancyId"`
// Email address of the recipient.
RecipientEmailAddress *string `mandatory:"false" json:"recipientEmailAddress"`
// A user-created name to describe the invitation. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The list of subjects this invitation contains.
Subjects []InvitationSubjectEnum `mandatory:"false" json:"subjects"`
// 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 CreateSenderInvitationDetails) String() string
func (m CreateSenderInvitationDetails) 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
CreateSenderInvitationRequest wrapper for the CreateSenderInvitation operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/CreateSenderInvitation.go.html to see an example of how to use CreateSenderInvitationRequest.
type CreateSenderInvitationRequest struct {
// Parameters for sender invitation creation.
CreateSenderInvitationDetails `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
// will 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 CreateSenderInvitationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateSenderInvitationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSenderInvitationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSenderInvitationRequest) String() string
func (request CreateSenderInvitationRequest) 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
CreateSenderInvitationResponse wrapper for the CreateSenderInvitation operation
type CreateSenderInvitationResponse struct {
// The underlying http response
RawResponse *http.Response
// The SenderInvitation instance
SenderInvitation `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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateSenderInvitationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSenderInvitationResponse) String() string
CreateSubscriptionMappingDetails CreateSubscriptionMappingDetails contains subscription and compartment identified by the tenancy, and OCID information.
type CreateSubscriptionMappingDetails struct {
// OCID of the compartment. Always a tenancy OCID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// OCID of Subscription.
SubscriptionId *string `mandatory:"true" json:"subscriptionId"`
}
func (m CreateSubscriptionMappingDetails) String() string
func (m CreateSubscriptionMappingDetails) 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
CreateSubscriptionMappingRequest wrapper for the CreateSubscriptionMapping operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/CreateSubscriptionMapping.go.html to see an example of how to use CreateSubscriptionMappingRequest.
type CreateSubscriptionMappingRequest struct {
// Compartment ID and Subscription ID details to create a subscription mapping.
CreateSubscriptionMappingDetails `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"`
// 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
// will 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 CreateSubscriptionMappingRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateSubscriptionMappingRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSubscriptionMappingRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSubscriptionMappingRequest) String() string
func (request CreateSubscriptionMappingRequest) 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
CreateSubscriptionMappingResponse wrapper for the CreateSubscriptionMapping operation
type CreateSubscriptionMappingResponse struct {
// The underlying http response
RawResponse *http.Response
// The SubscriptionMapping instance
SubscriptionMapping `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateSubscriptionMappingResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSubscriptionMappingResponse) String() string
DeleteDomainGovernanceRequest wrapper for the DeleteDomainGovernance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/DeleteDomainGovernance.go.html to see an example of how to use DeleteDomainGovernanceRequest.
type DeleteDomainGovernanceRequest struct {
// The domain governance OCID.
DomainGovernanceId *string `mandatory:"true" contributesTo:"path" name:"domainGovernanceId"`
// 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 DeleteDomainGovernanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDomainGovernanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDomainGovernanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDomainGovernanceRequest) String() string
func (request DeleteDomainGovernanceRequest) 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
DeleteDomainGovernanceResponse wrapper for the DeleteDomainGovernance operation
type DeleteDomainGovernanceResponse 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 DeleteDomainGovernanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDomainGovernanceResponse) String() string
DeleteDomainRequest wrapper for the DeleteDomain operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/DeleteDomain.go.html to see an example of how to use DeleteDomainRequest.
type DeleteDomainRequest struct {
// The domain OCID.
DomainId *string `mandatory:"true" contributesTo:"path" name:"domainId"`
// 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 DeleteDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDomainRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDomainRequest) String() string
func (request DeleteDomainRequest) 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
DeleteDomainResponse wrapper for the DeleteDomain operation
type DeleteDomainResponse 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 DeleteDomainResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDomainResponse) String() string
DeleteLinkRequest wrapper for the DeleteLink operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/DeleteLink.go.html to see an example of how to use DeleteLinkRequest.
type DeleteLinkRequest struct {
// OCID of the link to terminate.
LinkId *string `mandatory:"true" contributesTo:"path" name:"linkId"`
// 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 DeleteLinkRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteLinkRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteLinkRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteLinkRequest) String() string
func (request DeleteLinkRequest) 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
DeleteLinkResponse wrapper for the DeleteLink operation
type DeleteLinkResponse 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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response DeleteLinkResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteLinkResponse) String() string
DeleteOrganizationTenancyRequest wrapper for the DeleteOrganizationTenancy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/DeleteOrganizationTenancy.go.html to see an example of how to use DeleteOrganizationTenancyRequest.
type DeleteOrganizationTenancyRequest struct {
// OCID of the tenancy to be terminated.
OrganizationTenancyId *string `mandatory:"true" contributesTo:"path" name:"organizationTenancyId"`
// 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
// will 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 DeleteOrganizationTenancyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteOrganizationTenancyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteOrganizationTenancyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteOrganizationTenancyRequest) String() string
func (request DeleteOrganizationTenancyRequest) 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
DeleteOrganizationTenancyResponse wrapper for the DeleteOrganizationTenancy operation
type DeleteOrganizationTenancyResponse 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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response DeleteOrganizationTenancyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteOrganizationTenancyResponse) String() string
DeleteSubscriptionMappingRequest wrapper for the DeleteSubscriptionMapping operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/DeleteSubscriptionMapping.go.html to see an example of how to use DeleteSubscriptionMappingRequest.
type DeleteSubscriptionMappingRequest struct {
// OCID of the subscription mapping ID.
SubscriptionMappingId *string `mandatory:"true" contributesTo:"path" name:"subscriptionMappingId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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"`
// 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 DeleteSubscriptionMappingRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteSubscriptionMappingRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteSubscriptionMappingRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteSubscriptionMappingRequest) String() string
func (request DeleteSubscriptionMappingRequest) 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
DeleteSubscriptionMappingResponse wrapper for the DeleteSubscriptionMapping operation
type DeleteSubscriptionMappingResponse 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 DeleteSubscriptionMappingResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteSubscriptionMappingResponse) String() string
Domain The domain model that is associated with a tenancy.
type Domain struct {
// The OCID of the domain.
Id *string `mandatory:"true" json:"id"`
// The domain name.
DomainName *string `mandatory:"true" json:"domainName"`
// The OCID of the tenancy that has started the registration process for this domain.
OwnerId *string `mandatory:"true" json:"ownerId"`
// Lifecycle state of the domain.
LifecycleState DomainLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Status of the domain.
Status DomainStatusEnum `mandatory:"true" json:"status"`
// The code that the owner of the domain will need to add as a TXT record to their domain.
TxtRecord *string `mandatory:"true" json:"txtRecord"`
// Date-time when this domain was created. An RFC 3339-formatted date and time string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Date-time when this domain was last updated. An RFC 3339-formatted date and time string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// 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 Domain) String() string
func (m Domain) 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
DomainClient a client for Domain
type DomainClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewDomainClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client DomainClient, err error)
NewDomainClientWithConfigurationProvider Creates a new default Domain client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewDomainClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client DomainClient, err error)
NewDomainClientWithOboToken Creates a new default Domain 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 *DomainClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client DomainClient) CreateDomain(ctx context.Context, request CreateDomainRequest) (response CreateDomainResponse, err error)
CreateDomain Begins the registration process for claiming a domain.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/CreateDomain.go.html to see an example of how to use CreateDomain API.
func (client DomainClient) DeleteDomain(ctx context.Context, request DeleteDomainRequest) (response DeleteDomainResponse, err error)
DeleteDomain Releases the domain, making it available to be claimed again by another tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/DeleteDomain.go.html to see an example of how to use DeleteDomain API.
func (client DomainClient) GetDomain(ctx context.Context, request GetDomainRequest) (response GetDomainResponse, err error)
GetDomain Gets information about the domain.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetDomain.go.html to see an example of how to use GetDomain API.
func (client DomainClient) ListDomains(ctx context.Context, request ListDomainsRequest) (response ListDomainsResponse, err error)
ListDomains Return a (paginated) list of domains.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListDomains.go.html to see an example of how to use ListDomains API.
func (client *DomainClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client DomainClient) UpdateDomain(ctx context.Context, request UpdateDomainRequest) (response UpdateDomainResponse, err error)
UpdateDomain Updates the domain.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/UpdateDomain.go.html to see an example of how to use UpdateDomain API.
DomainCollection Result of a query request for a list of domains. Contains DomainSummary items.
type DomainCollection struct {
// Array containing DomainSummary items.
Items []DomainSummary `mandatory:"true" json:"items"`
}
func (m DomainCollection) String() string
func (m DomainCollection) 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
DomainGovernance The model for a domain governance entity.
type DomainGovernance struct {
// The OCID of the domain governance entity.
Id *string `mandatory:"true" json:"id"`
// The OCID of the tenancy that owns this domain governance entity.
OwnerId *string `mandatory:"true" json:"ownerId"`
// The OCID of the domain associated with this domain governance entity.
DomainId *string `mandatory:"true" json:"domainId"`
// Lifecycle state of the domain governance entity.
LifecycleState DomainGovernanceLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The ONS topic associated with this domain governance entity.
OnsTopicId *string `mandatory:"true" json:"onsTopicId"`
// The ONS subscription associated with this domain governance entity.
OnsSubscriptionId *string `mandatory:"true" json:"onsSubscriptionId"`
// Indicates whether governance is enabled for this domain.
IsGovernanceEnabled *bool `mandatory:"false" json:"isGovernanceEnabled"`
// Email address to be used to notify the user, and that the ONS subscription will be created with.
SubscriptionEmail *string `mandatory:"false" json:"subscriptionEmail"`
// Date-time when this domain governance was created. An RFC 3339-formatted date and time string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Date-time when this domain governance was last updated. An RFC 3339-formatted date and time string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// 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 DomainGovernance) String() string
func (m DomainGovernance) 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
DomainGovernanceClient a client for DomainGovernance
type DomainGovernanceClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewDomainGovernanceClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client DomainGovernanceClient, err error)
NewDomainGovernanceClientWithConfigurationProvider Creates a new default DomainGovernance client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewDomainGovernanceClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client DomainGovernanceClient, err error)
NewDomainGovernanceClientWithOboToken Creates a new default DomainGovernance 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 *DomainGovernanceClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client DomainGovernanceClient) CreateDomainGovernance(ctx context.Context, request CreateDomainGovernanceRequest) (response CreateDomainGovernanceResponse, err error)
CreateDomainGovernance Adds domain governance to a claimed domain.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/CreateDomainGovernance.go.html to see an example of how to use CreateDomainGovernance API.
func (client DomainGovernanceClient) DeleteDomainGovernance(ctx context.Context, request DeleteDomainGovernanceRequest) (response DeleteDomainGovernanceResponse, err error)
DeleteDomainGovernance Removes domain governance from a claimed domain.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/DeleteDomainGovernance.go.html to see an example of how to use DeleteDomainGovernance API.
func (client DomainGovernanceClient) GetDomainGovernance(ctx context.Context, request GetDomainGovernanceRequest) (response GetDomainGovernanceResponse, err error)
GetDomainGovernance Gets information about the domain governance entity.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetDomainGovernance.go.html to see an example of how to use GetDomainGovernance API.
func (client DomainGovernanceClient) ListDomainGovernances(ctx context.Context, request ListDomainGovernancesRequest) (response ListDomainGovernancesResponse, err error)
ListDomainGovernances Return a (paginated) list of domain governance entities.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListDomainGovernances.go.html to see an example of how to use ListDomainGovernances API.
func (client *DomainGovernanceClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client DomainGovernanceClient) UpdateDomainGovernance(ctx context.Context, request UpdateDomainGovernanceRequest) (response UpdateDomainGovernanceResponse, err error)
UpdateDomainGovernance Updates the domain governance entity.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/UpdateDomainGovernance.go.html to see an example of how to use UpdateDomainGovernance API.
DomainGovernanceCollection Result of a query request for a list of domain governance entities. Contains DomainGovernanceSummary items.
type DomainGovernanceCollection struct {
// Array containing DomainGovernanceSummary items.
Items []DomainGovernanceSummary `mandatory:"true" json:"items"`
}
func (m DomainGovernanceCollection) String() string
func (m DomainGovernanceCollection) 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
DomainGovernanceLifecycleStateEnum Enum with underlying type: string
type DomainGovernanceLifecycleStateEnum string
Set of constants representing the allowable values for DomainGovernanceLifecycleStateEnum
const (
DomainGovernanceLifecycleStateActive DomainGovernanceLifecycleStateEnum = "ACTIVE"
DomainGovernanceLifecycleStateInactive DomainGovernanceLifecycleStateEnum = "INACTIVE"
)
func GetDomainGovernanceLifecycleStateEnumValues() []DomainGovernanceLifecycleStateEnum
GetDomainGovernanceLifecycleStateEnumValues Enumerates the set of values for DomainGovernanceLifecycleStateEnum
func GetMappingDomainGovernanceLifecycleStateEnum(val string) (DomainGovernanceLifecycleStateEnum, bool)
GetMappingDomainGovernanceLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DomainGovernanceSummary The summary of a domain govenance entity owned by a tenancy.
type DomainGovernanceSummary struct {
// The OCID of the domain governance entity.
Id *string `mandatory:"true" json:"id"`
// The OCID of the tenancy that owns this domain governance entity.
OwnerId *string `mandatory:"true" json:"ownerId"`
// The OCID of the domain associated with this domain governance entity.
DomainId *string `mandatory:"true" json:"domainId"`
// The lifecycle state of the domain governance entity.
LifecycleState DomainGovernanceLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Indicates whether governance is enabled for this domain.
IsGovernanceEnabled *bool `mandatory:"true" json:"isGovernanceEnabled"`
// The ONS topic associated with this domain governance entity.
OnsTopicId *string `mandatory:"true" json:"onsTopicId"`
// The ONS subscription associated with this domain governance entity.
OnsSubscriptionId *string `mandatory:"true" json:"onsSubscriptionId"`
// Email address to be used to notify the user, and that the ONS subscription will be created with.
SubscriptionEmail *string `mandatory:"false" json:"subscriptionEmail"`
// Date-time when this domain governance was created. An RFC 3339-formatted date and time string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Date-time when this domain governance was last updated. An RFC 3339-formatted date and time string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// 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 DomainGovernanceSummary) String() string
func (m DomainGovernanceSummary) 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
DomainLifecycleStateEnum Enum with underlying type: string
type DomainLifecycleStateEnum string
Set of constants representing the allowable values for DomainLifecycleStateEnum
const (
DomainLifecycleStateActive DomainLifecycleStateEnum = "ACTIVE"
DomainLifecycleStateDeleted DomainLifecycleStateEnum = "DELETED"
DomainLifecycleStateFailed DomainLifecycleStateEnum = "FAILED"
)
func GetDomainLifecycleStateEnumValues() []DomainLifecycleStateEnum
GetDomainLifecycleStateEnumValues Enumerates the set of values for DomainLifecycleStateEnum
func GetMappingDomainLifecycleStateEnum(val string) (DomainLifecycleStateEnum, bool)
GetMappingDomainLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DomainStatusEnum Enum with underlying type: string
type DomainStatusEnum string
Set of constants representing the allowable values for DomainStatusEnum
const (
DomainStatusPending DomainStatusEnum = "PENDING"
DomainStatusReleasing DomainStatusEnum = "RELEASING"
DomainStatusReleased DomainStatusEnum = "RELEASED"
DomainStatusExpiring DomainStatusEnum = "EXPIRING"
DomainStatusRevoking DomainStatusEnum = "REVOKING"
DomainStatusRevoked DomainStatusEnum = "REVOKED"
DomainStatusActive DomainStatusEnum = "ACTIVE"
DomainStatusFailed DomainStatusEnum = "FAILED"
)
func GetDomainStatusEnumValues() []DomainStatusEnum
GetDomainStatusEnumValues Enumerates the set of values for DomainStatusEnum
func GetMappingDomainStatusEnum(val string) (DomainStatusEnum, bool)
GetMappingDomainStatusEnum performs case Insensitive comparison on enum value and return the desired enum
DomainSummary The summary of a domain owned by a tenancy.
type DomainSummary struct {
// OCID of the domain.
Id *string `mandatory:"true" json:"id"`
// The domain name.
DomainName *string `mandatory:"true" json:"domainName"`
// The OCID of the tenancy that has started the registration process for this domain.
OwnerId *string `mandatory:"true" json:"ownerId"`
// The lifecycle state of the domain.
LifecycleState DomainLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Status of the domain.
Status DomainStatusEnum `mandatory:"true" json:"status"`
// The code that the owner of the domain will need to add as a TXT record to their domain.
TxtRecord *string `mandatory:"true" json:"txtRecord"`
// Date-time when this domain was created. An RFC 3339-formatted date and time string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Date-time when this domain was last updated. An RFC 3339-formatted date and time string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// 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 DomainSummary) String() string
func (m DomainSummary) 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
EntityVersionEnum Enum with underlying type: string
type EntityVersionEnum string
Set of constants representing the allowable values for EntityVersionEnum
const (
EntityVersionV1 EntityVersionEnum = "V1"
EntityVersionV2 EntityVersionEnum = "V2"
)
func GetEntityVersionEnumValues() []EntityVersionEnum
GetEntityVersionEnumValues Enumerates the set of values for EntityVersionEnum
func GetMappingEntityVersionEnum(val string) (EntityVersionEnum, bool)
GetMappingEntityVersionEnum performs case Insensitive comparison on enum value and return the desired enum
GetAssignedSubscriptionRequest wrapper for the GetAssignedSubscription operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetAssignedSubscription.go.html to see an example of how to use GetAssignedSubscriptionRequest.
type GetAssignedSubscriptionRequest struct {
// OCID of the assigned Oracle Cloud Subscription.
AssignedSubscriptionId *string `mandatory:"true" contributesTo:"path" name:"assignedSubscriptionId"`
// 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 GetAssignedSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAssignedSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAssignedSubscriptionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAssignedSubscriptionRequest) String() string
func (request GetAssignedSubscriptionRequest) 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
GetAssignedSubscriptionResponse wrapper for the GetAssignedSubscription operation
type GetAssignedSubscriptionResponse struct {
// The underlying http response
RawResponse *http.Response
// The AssignedSubscription instance
AssignedSubscription `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response GetAssignedSubscriptionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAssignedSubscriptionResponse) String() string
GetDomainGovernanceRequest wrapper for the GetDomainGovernance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetDomainGovernance.go.html to see an example of how to use GetDomainGovernanceRequest.
type GetDomainGovernanceRequest struct {
// The domain governance OCID.
DomainGovernanceId *string `mandatory:"true" contributesTo:"path" name:"domainGovernanceId"`
// 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 GetDomainGovernanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDomainGovernanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDomainGovernanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDomainGovernanceRequest) String() string
func (request GetDomainGovernanceRequest) 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
GetDomainGovernanceResponse wrapper for the GetDomainGovernance operation
type GetDomainGovernanceResponse struct {
// The underlying http response
RawResponse *http.Response
// The DomainGovernance instance
DomainGovernance `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 GetDomainGovernanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDomainGovernanceResponse) String() string
GetDomainRequest wrapper for the GetDomain operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetDomain.go.html to see an example of how to use GetDomainRequest.
type GetDomainRequest struct {
// The domain OCID.
DomainId *string `mandatory:"true" contributesTo:"path" name:"domainId"`
// 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 GetDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDomainRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDomainRequest) String() string
func (request GetDomainRequest) 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
GetDomainResponse wrapper for the GetDomain operation
type GetDomainResponse struct {
// The underlying http response
RawResponse *http.Response
// The Domain instance
Domain `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 GetDomainResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDomainResponse) String() string
GetLinkRequest wrapper for the GetLink operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetLink.go.html to see an example of how to use GetLinkRequest.
type GetLinkRequest struct {
// OCID of the link to retrieve.
LinkId *string `mandatory:"true" contributesTo:"path" name:"linkId"`
// 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 GetLinkRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetLinkRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetLinkRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetLinkRequest) String() string
func (request GetLinkRequest) 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
GetLinkResponse wrapper for the GetLink operation
type GetLinkResponse struct {
// The underlying http response
RawResponse *http.Response
// The Link instance
Link `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 GetLinkResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetLinkResponse) String() string
GetOrderRequest wrapper for the GetOrder operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetOrder.go.html to see an example of how to use GetOrderRequest.
type GetOrderRequest struct {
// Activation token containing an order ID. A JWT RFC 7519-formatted string.
ActivationToken *string `mandatory:"true" contributesTo:"path" name:"activationToken"`
// 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 GetOrderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetOrderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetOrderRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetOrderRequest) String() string
func (request GetOrderRequest) 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
GetOrderResponse wrapper for the GetOrder operation
type GetOrderResponse struct {
// The underlying http response
RawResponse *http.Response
// The Order instance
Order `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetOrderResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetOrderResponse) String() string
GetOrganizationRequest wrapper for the GetOrganization operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetOrganization.go.html to see an example of how to use GetOrganizationRequest.
type GetOrganizationRequest struct {
// OCID of the organization to retrieve.
OrganizationId *string `mandatory:"true" contributesTo:"path" name:"organizationId"`
// 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 GetOrganizationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetOrganizationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetOrganizationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetOrganizationRequest) String() string
func (request GetOrganizationRequest) 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
GetOrganizationResponse wrapper for the GetOrganization operation
type GetOrganizationResponse struct {
// The underlying http response
RawResponse *http.Response
// The Organization instance
Organization `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 GetOrganizationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetOrganizationResponse) String() string
GetOrganizationTenancyRequest wrapper for the GetOrganizationTenancy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetOrganizationTenancy.go.html to see an example of how to use GetOrganizationTenancyRequest.
type GetOrganizationTenancyRequest struct {
// OCID of the organization.
OrganizationId *string `mandatory:"true" contributesTo:"path" name:"organizationId"`
// OCID of the tenancy to retrieve.
TenancyId *string `mandatory:"true" contributesTo:"path" name:"tenancyId"`
// 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 GetOrganizationTenancyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetOrganizationTenancyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetOrganizationTenancyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetOrganizationTenancyRequest) String() string
func (request GetOrganizationTenancyRequest) 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
GetOrganizationTenancyResponse wrapper for the GetOrganizationTenancy operation
type GetOrganizationTenancyResponse struct {
// The underlying http response
RawResponse *http.Response
// The OrganizationTenancy instance
OrganizationTenancy `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 GetOrganizationTenancyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetOrganizationTenancyResponse) String() string
GetRecipientInvitationRequest wrapper for the GetRecipientInvitation operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetRecipientInvitation.go.html to see an example of how to use GetRecipientInvitationRequest.
type GetRecipientInvitationRequest struct {
// OCID of the recipient invitation to retrieve.
RecipientInvitationId *string `mandatory:"true" contributesTo:"path" name:"recipientInvitationId"`
// 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 GetRecipientInvitationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetRecipientInvitationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetRecipientInvitationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetRecipientInvitationRequest) String() string
func (request GetRecipientInvitationRequest) 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
GetRecipientInvitationResponse wrapper for the GetRecipientInvitation operation
type GetRecipientInvitationResponse struct {
// The underlying http response
RawResponse *http.Response
// The RecipientInvitation instance
RecipientInvitation `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response GetRecipientInvitationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetRecipientInvitationResponse) String() string
GetSenderInvitationRequest wrapper for the GetSenderInvitation operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetSenderInvitation.go.html to see an example of how to use GetSenderInvitationRequest.
type GetSenderInvitationRequest struct {
// OCID of the sender invitation to retrieve.
SenderInvitationId *string `mandatory:"true" contributesTo:"path" name:"senderInvitationId"`
// 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 GetSenderInvitationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSenderInvitationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSenderInvitationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSenderInvitationRequest) String() string
func (request GetSenderInvitationRequest) 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
GetSenderInvitationResponse wrapper for the GetSenderInvitation operation
type GetSenderInvitationResponse struct {
// The underlying http response
RawResponse *http.Response
// The SenderInvitation instance
SenderInvitation `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 GetSenderInvitationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSenderInvitationResponse) String() string
GetSubscriptionMappingRequest wrapper for the GetSubscriptionMapping operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetSubscriptionMapping.go.html to see an example of how to use GetSubscriptionMappingRequest.
type GetSubscriptionMappingRequest struct {
// OCID of the subscriptionMappingId.
SubscriptionMappingId *string `mandatory:"true" contributesTo:"path" name:"subscriptionMappingId"`
// 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 GetSubscriptionMappingRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSubscriptionMappingRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSubscriptionMappingRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSubscriptionMappingRequest) String() string
func (request GetSubscriptionMappingRequest) 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
GetSubscriptionMappingResponse wrapper for the GetSubscriptionMapping operation
type GetSubscriptionMappingResponse struct {
// The underlying http response
RawResponse *http.Response
// The SubscriptionMapping instance
SubscriptionMapping `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response GetSubscriptionMappingResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSubscriptionMappingResponse) String() string
GetSubscriptionRequest wrapper for the GetSubscription operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetSubscription.go.html to see an example of how to use GetSubscriptionRequest.
type GetSubscriptionRequest struct {
// OCID of the subscription.
SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`
// 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 GetSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSubscriptionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSubscriptionRequest) String() string
func (request GetSubscriptionRequest) 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
GetSubscriptionResponse wrapper for the GetSubscription operation
type GetSubscriptionResponse struct {
// The underlying http response
RawResponse *http.Response
// The Subscription instance
Subscription `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response GetSubscriptionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSubscriptionResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/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"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *float32 `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
GovernanceClient a client for Governance
type GovernanceClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewGovernanceClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client GovernanceClient, err error)
NewGovernanceClientWithConfigurationProvider Creates a new default Governance client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewGovernanceClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client GovernanceClient, err error)
NewGovernanceClientWithOboToken Creates a new default Governance 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 GovernanceClient) AddGovernance(ctx context.Context, request AddGovernanceRequest) (response AddGovernanceResponse, err error)
AddGovernance Starts a work request to opt the tenancy in to governance rules.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/AddGovernance.go.html to see an example of how to use AddGovernance API.
func (client *GovernanceClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client GovernanceClient) RemoveGovernance(ctx context.Context, request RemoveGovernanceRequest) (response RemoveGovernanceResponse, err error)
RemoveGovernance Starts a work request to opt the tenancy out of governance rules.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/RemoveGovernance.go.html to see an example of how to use RemoveGovernance API.
func (client *GovernanceClient) SetRegion(region string)
SetRegion overrides the region of this client.
GovernanceStatusEnum Enum with underlying type: string
type GovernanceStatusEnum string
Set of constants representing the allowable values for GovernanceStatusEnum
const (
GovernanceStatusOptedIn GovernanceStatusEnum = "OPTED_IN"
GovernanceStatusOptedOut GovernanceStatusEnum = "OPTED_OUT"
)
func GetGovernanceStatusEnumValues() []GovernanceStatusEnum
GetGovernanceStatusEnumValues Enumerates the set of values for GovernanceStatusEnum
func GetMappingGovernanceStatusEnum(val string) (GovernanceStatusEnum, bool)
GetMappingGovernanceStatusEnum performs case Insensitive comparison on enum value and return the desired enum
IgnoreRecipientInvitationRequest wrapper for the IgnoreRecipientInvitation operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/IgnoreRecipientInvitation.go.html to see an example of how to use IgnoreRecipientInvitationRequest.
type IgnoreRecipientInvitationRequest struct {
// OCID of recipient invitation to ignore.
RecipientInvitationId *string `mandatory:"true" contributesTo:"path" name:"recipientInvitationId"`
// 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
// will 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 IgnoreRecipientInvitationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request IgnoreRecipientInvitationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request IgnoreRecipientInvitationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request IgnoreRecipientInvitationRequest) String() string
func (request IgnoreRecipientInvitationRequest) 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
IgnoreRecipientInvitationResponse wrapper for the IgnoreRecipientInvitation operation
type IgnoreRecipientInvitationResponse struct {
// The underlying http response
RawResponse *http.Response
// The RecipientInvitation instance
RecipientInvitation `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response IgnoreRecipientInvitationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response IgnoreRecipientInvitationResponse) String() string
InvitationSubjectEnum Enum with underlying type: string
type InvitationSubjectEnum string
Set of constants representing the allowable values for InvitationSubjectEnum
const (
InvitationSubjectLink InvitationSubjectEnum = "LINK"
InvitationSubjectGovernance InvitationSubjectEnum = "GOVERNANCE"
)
func GetInvitationSubjectEnumValues() []InvitationSubjectEnum
GetInvitationSubjectEnumValues Enumerates the set of values for InvitationSubjectEnum
func GetMappingInvitationSubjectEnum(val string) (InvitationSubjectEnum, bool)
GetMappingInvitationSubjectEnum performs case Insensitive comparison on enum value and return the desired enum
LifecycleStateEnum Enum with underlying type: string
type LifecycleStateEnum string
Set of constants representing the allowable values for LifecycleStateEnum
const (
LifecycleStateCreating LifecycleStateEnum = "CREATING"
LifecycleStateActive LifecycleStateEnum = "ACTIVE"
LifecycleStateInactive LifecycleStateEnum = "INACTIVE"
LifecycleStateUpdating LifecycleStateEnum = "UPDATING"
LifecycleStateFailed LifecycleStateEnum = "FAILED"
LifecycleStateTerminated LifecycleStateEnum = "TERMINATED"
)
func GetLifecycleStateEnumValues() []LifecycleStateEnum
GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum
func GetMappingLifecycleStateEnum(val string) (LifecycleStateEnum, bool)
GetMappingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
Link A link between a parent tenancy and a child tenancy.
type Link struct {
// OCID of the link.
Id *string `mandatory:"true" json:"id"`
// OCID of the parent tenancy.
ParentTenancyId *string `mandatory:"true" json:"parentTenancyId"`
// OCID of the child tenancy.
ChildTenancyId *string `mandatory:"true" json:"childTenancyId"`
// Date-time when this link was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Lifecycle state of the link.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Date-time when this link was last updated.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Date-time when this link was terminated.
TimeTerminated *common.SDKTime `mandatory:"false" json:"timeTerminated"`
}
func (m Link) String() string
func (m Link) 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
LinkClient a client for Link
type LinkClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewLinkClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client LinkClient, err error)
NewLinkClientWithConfigurationProvider Creates a new default Link client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewLinkClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client LinkClient, err error)
NewLinkClientWithOboToken Creates a new default Link 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 *LinkClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client LinkClient) DeleteLink(ctx context.Context, request DeleteLinkRequest) (response DeleteLinkResponse, err error)
DeleteLink Starts the link termination workflow.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/DeleteLink.go.html to see an example of how to use DeleteLink API.
func (client LinkClient) GetLink(ctx context.Context, request GetLinkRequest) (response GetLinkResponse, err error)
GetLink Gets information about the link.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetLink.go.html to see an example of how to use GetLink API.
func (client LinkClient) ListLinks(ctx context.Context, request ListLinksRequest) (response ListLinksResponse, err error)
ListLinks Return a (paginated) list of links.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListLinks.go.html to see an example of how to use ListLinks API.
func (client *LinkClient) SetRegion(region string)
SetRegion overrides the region of this client.
LinkCollection Result of a query request for a list of links. Contains Link items.
type LinkCollection struct {
// Array containing LinkSummary items.
Items []LinkSummary `mandatory:"true" json:"items"`
}
func (m LinkCollection) String() string
func (m LinkCollection) 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
LinkSummary The summary of a link between a parent tenancy and a child tenancy.
type LinkSummary struct {
// OCID of the link.
Id *string `mandatory:"true" json:"id"`
// OCID of the parent tenancy.
ParentTenancyId *string `mandatory:"true" json:"parentTenancyId"`
// OCID of the child tenancy.
ChildTenancyId *string `mandatory:"true" json:"childTenancyId"`
// Date-time when this link was created
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Lifecycle state of the link.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Date-time when this link was last updated.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Date-time when this link was terminated.
TimeTerminated *common.SDKTime `mandatory:"false" json:"timeTerminated"`
// 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 LinkSummary) String() string
func (m LinkSummary) 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
ListAssignedSubscriptionLineItemsRequest wrapper for the ListAssignedSubscriptionLineItems operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListAssignedSubscriptionLineItems.go.html to see an example of how to use ListAssignedSubscriptionLineItemsRequest.
type ListAssignedSubscriptionLineItemsRequest struct {
// OCID of the assigned Oracle Cloud Subscription.
AssignedSubscriptionId *string `mandatory:"true" contributesTo:"path" name:"assignedSubscriptionId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, whether 'asc' or 'desc'.
SortOrder ListAssignedSubscriptionLineItemsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided.
// * The default order for timeCreated is descending.
// * The default order for displayName is ascending.
// * If no value is specified, timeCreated is the default.
SortBy ListAssignedSubscriptionLineItemsSortByEnum `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 ListAssignedSubscriptionLineItemsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAssignedSubscriptionLineItemsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAssignedSubscriptionLineItemsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAssignedSubscriptionLineItemsRequest) String() string
func (request ListAssignedSubscriptionLineItemsRequest) 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
ListAssignedSubscriptionLineItemsResponse wrapper for the ListAssignedSubscriptionLineItems operation
type ListAssignedSubscriptionLineItemsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of AssignedSubscriptionLineItemCollection instances
AssignedSubscriptionLineItemCollection `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 ListAssignedSubscriptionLineItemsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAssignedSubscriptionLineItemsResponse) String() string
ListAssignedSubscriptionLineItemsSortByEnum Enum with underlying type: string
type ListAssignedSubscriptionLineItemsSortByEnum string
Set of constants representing the allowable values for ListAssignedSubscriptionLineItemsSortByEnum
const (
ListAssignedSubscriptionLineItemsSortByTimecreated ListAssignedSubscriptionLineItemsSortByEnum = "timeCreated"
ListAssignedSubscriptionLineItemsSortByDisplayname ListAssignedSubscriptionLineItemsSortByEnum = "displayName"
)
func GetListAssignedSubscriptionLineItemsSortByEnumValues() []ListAssignedSubscriptionLineItemsSortByEnum
GetListAssignedSubscriptionLineItemsSortByEnumValues Enumerates the set of values for ListAssignedSubscriptionLineItemsSortByEnum
func GetMappingListAssignedSubscriptionLineItemsSortByEnum(val string) (ListAssignedSubscriptionLineItemsSortByEnum, bool)
GetMappingListAssignedSubscriptionLineItemsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListAssignedSubscriptionLineItemsSortOrderEnum Enum with underlying type: string
type ListAssignedSubscriptionLineItemsSortOrderEnum string
Set of constants representing the allowable values for ListAssignedSubscriptionLineItemsSortOrderEnum
const (
ListAssignedSubscriptionLineItemsSortOrderAsc ListAssignedSubscriptionLineItemsSortOrderEnum = "ASC"
ListAssignedSubscriptionLineItemsSortOrderDesc ListAssignedSubscriptionLineItemsSortOrderEnum = "DESC"
)
func GetListAssignedSubscriptionLineItemsSortOrderEnumValues() []ListAssignedSubscriptionLineItemsSortOrderEnum
GetListAssignedSubscriptionLineItemsSortOrderEnumValues Enumerates the set of values for ListAssignedSubscriptionLineItemsSortOrderEnum
func GetMappingListAssignedSubscriptionLineItemsSortOrderEnum(val string) (ListAssignedSubscriptionLineItemsSortOrderEnum, bool)
GetMappingListAssignedSubscriptionLineItemsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListAssignedSubscriptionsEntityVersionEnum Enum with underlying type: string
type ListAssignedSubscriptionsEntityVersionEnum string
Set of constants representing the allowable values for ListAssignedSubscriptionsEntityVersionEnum
const (
ListAssignedSubscriptionsEntityVersionV1 ListAssignedSubscriptionsEntityVersionEnum = "V1"
ListAssignedSubscriptionsEntityVersionV2 ListAssignedSubscriptionsEntityVersionEnum = "V2"
)
func GetListAssignedSubscriptionsEntityVersionEnumValues() []ListAssignedSubscriptionsEntityVersionEnum
GetListAssignedSubscriptionsEntityVersionEnumValues Enumerates the set of values for ListAssignedSubscriptionsEntityVersionEnum
func GetMappingListAssignedSubscriptionsEntityVersionEnum(val string) (ListAssignedSubscriptionsEntityVersionEnum, bool)
GetMappingListAssignedSubscriptionsEntityVersionEnum performs case Insensitive comparison on enum value and return the desired enum
ListAssignedSubscriptionsRequest wrapper for the ListAssignedSubscriptions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListAssignedSubscriptions.go.html to see an example of how to use ListAssignedSubscriptionsRequest.
type ListAssignedSubscriptionsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The ID of the subscription to which the tenancy is associated.
SubscriptionId *string `mandatory:"false" contributesTo:"query" name:"subscriptionId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, whether 'asc' or 'desc'.
SortOrder ListAssignedSubscriptionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided.
// * The default order for timeCreated is descending.
// * The default order for displayName is ascending.
// * If no value is specified, timeCreated is the default.
SortBy ListAssignedSubscriptionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The version of the subscription entity.
EntityVersion ListAssignedSubscriptionsEntityVersionEnum `mandatory:"false" contributesTo:"query" name:"entityVersion" 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 ListAssignedSubscriptionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAssignedSubscriptionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAssignedSubscriptionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAssignedSubscriptionsRequest) String() string
func (request ListAssignedSubscriptionsRequest) 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
ListAssignedSubscriptionsResponse wrapper for the ListAssignedSubscriptions operation
type ListAssignedSubscriptionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of AssignedSubscriptionCollection instances
AssignedSubscriptionCollection `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 ListAssignedSubscriptionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAssignedSubscriptionsResponse) String() string
ListAssignedSubscriptionsSortByEnum Enum with underlying type: string
type ListAssignedSubscriptionsSortByEnum string
Set of constants representing the allowable values for ListAssignedSubscriptionsSortByEnum
const (
ListAssignedSubscriptionsSortByTimecreated ListAssignedSubscriptionsSortByEnum = "timeCreated"
ListAssignedSubscriptionsSortByDisplayname ListAssignedSubscriptionsSortByEnum = "displayName"
)
func GetListAssignedSubscriptionsSortByEnumValues() []ListAssignedSubscriptionsSortByEnum
GetListAssignedSubscriptionsSortByEnumValues Enumerates the set of values for ListAssignedSubscriptionsSortByEnum
func GetMappingListAssignedSubscriptionsSortByEnum(val string) (ListAssignedSubscriptionsSortByEnum, bool)
GetMappingListAssignedSubscriptionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListAssignedSubscriptionsSortOrderEnum Enum with underlying type: string
type ListAssignedSubscriptionsSortOrderEnum string
Set of constants representing the allowable values for ListAssignedSubscriptionsSortOrderEnum
const (
ListAssignedSubscriptionsSortOrderAsc ListAssignedSubscriptionsSortOrderEnum = "ASC"
ListAssignedSubscriptionsSortOrderDesc ListAssignedSubscriptionsSortOrderEnum = "DESC"
)
func GetListAssignedSubscriptionsSortOrderEnumValues() []ListAssignedSubscriptionsSortOrderEnum
GetListAssignedSubscriptionsSortOrderEnumValues Enumerates the set of values for ListAssignedSubscriptionsSortOrderEnum
func GetMappingListAssignedSubscriptionsSortOrderEnum(val string) (ListAssignedSubscriptionsSortOrderEnum, bool)
GetMappingListAssignedSubscriptionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListAvailableRegionsRequest wrapper for the ListAvailableRegions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListAvailableRegions.go.html to see an example of how to use ListAvailableRegionsRequest.
type ListAvailableRegionsRequest struct {
// OCID of the subscription.
SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// 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 ListAvailableRegionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAvailableRegionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAvailableRegionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAvailableRegionsRequest) String() string
func (request ListAvailableRegionsRequest) 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
ListAvailableRegionsResponse wrapper for the ListAvailableRegions operation
type ListAvailableRegionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of AvailableRegionCollection instances
AvailableRegionCollection `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 ListAvailableRegionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAvailableRegionsResponse) String() string
ListDomainGovernancesLifecycleStateEnum Enum with underlying type: string
type ListDomainGovernancesLifecycleStateEnum string
Set of constants representing the allowable values for ListDomainGovernancesLifecycleStateEnum
const (
ListDomainGovernancesLifecycleStateCreating ListDomainGovernancesLifecycleStateEnum = "CREATING"
ListDomainGovernancesLifecycleStateActive ListDomainGovernancesLifecycleStateEnum = "ACTIVE"
ListDomainGovernancesLifecycleStateInactive ListDomainGovernancesLifecycleStateEnum = "INACTIVE"
ListDomainGovernancesLifecycleStateUpdating ListDomainGovernancesLifecycleStateEnum = "UPDATING"
ListDomainGovernancesLifecycleStateFailed ListDomainGovernancesLifecycleStateEnum = "FAILED"
ListDomainGovernancesLifecycleStateTerminated ListDomainGovernancesLifecycleStateEnum = "TERMINATED"
)
func GetListDomainGovernancesLifecycleStateEnumValues() []ListDomainGovernancesLifecycleStateEnum
GetListDomainGovernancesLifecycleStateEnumValues Enumerates the set of values for ListDomainGovernancesLifecycleStateEnum
func GetMappingListDomainGovernancesLifecycleStateEnum(val string) (ListDomainGovernancesLifecycleStateEnum, bool)
GetMappingListDomainGovernancesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListDomainGovernancesRequest wrapper for the ListDomainGovernances operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListDomainGovernances.go.html to see an example of how to use ListDomainGovernancesRequest.
type ListDomainGovernancesRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The domain OCID.
DomainId *string `mandatory:"false" contributesTo:"query" name:"domainId"`
// The domain governance OCID.
DomainGovernanceId *string `mandatory:"false" contributesTo:"query" name:"domainGovernanceId"`
// The lifecycle state of the resource.
LifecycleState ListDomainGovernancesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that exactly match the name given.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order can be provided.
// * The default order for timeCreated is descending.
// * The default order for displayName is ascending.
// * If no value is specified, timeCreated is the default.
SortBy ListDomainGovernancesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, whether 'asc' or 'desc'.
SortOrder ListDomainGovernancesSortOrderEnum `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 ListDomainGovernancesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDomainGovernancesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDomainGovernancesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDomainGovernancesRequest) String() string
func (request ListDomainGovernancesRequest) 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
ListDomainGovernancesResponse wrapper for the ListDomainGovernances operation
type ListDomainGovernancesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DomainGovernanceCollection instances
DomainGovernanceCollection `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 ListDomainGovernancesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDomainGovernancesResponse) String() string
ListDomainGovernancesSortByEnum Enum with underlying type: string
type ListDomainGovernancesSortByEnum string
Set of constants representing the allowable values for ListDomainGovernancesSortByEnum
const (
ListDomainGovernancesSortByTimecreated ListDomainGovernancesSortByEnum = "timeCreated"
ListDomainGovernancesSortByDisplayname ListDomainGovernancesSortByEnum = "displayName"
)
func GetListDomainGovernancesSortByEnumValues() []ListDomainGovernancesSortByEnum
GetListDomainGovernancesSortByEnumValues Enumerates the set of values for ListDomainGovernancesSortByEnum
func GetMappingListDomainGovernancesSortByEnum(val string) (ListDomainGovernancesSortByEnum, bool)
GetMappingListDomainGovernancesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDomainGovernancesSortOrderEnum Enum with underlying type: string
type ListDomainGovernancesSortOrderEnum string
Set of constants representing the allowable values for ListDomainGovernancesSortOrderEnum
const (
ListDomainGovernancesSortOrderAsc ListDomainGovernancesSortOrderEnum = "ASC"
ListDomainGovernancesSortOrderDesc ListDomainGovernancesSortOrderEnum = "DESC"
)
func GetListDomainGovernancesSortOrderEnumValues() []ListDomainGovernancesSortOrderEnum
GetListDomainGovernancesSortOrderEnumValues Enumerates the set of values for ListDomainGovernancesSortOrderEnum
func GetMappingListDomainGovernancesSortOrderEnum(val string) (ListDomainGovernancesSortOrderEnum, bool)
GetMappingListDomainGovernancesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDomainsLifecycleStateEnum Enum with underlying type: string
type ListDomainsLifecycleStateEnum string
Set of constants representing the allowable values for ListDomainsLifecycleStateEnum
const (
ListDomainsLifecycleStateCreating ListDomainsLifecycleStateEnum = "CREATING"
ListDomainsLifecycleStateActive ListDomainsLifecycleStateEnum = "ACTIVE"
ListDomainsLifecycleStateInactive ListDomainsLifecycleStateEnum = "INACTIVE"
ListDomainsLifecycleStateUpdating ListDomainsLifecycleStateEnum = "UPDATING"
ListDomainsLifecycleStateFailed ListDomainsLifecycleStateEnum = "FAILED"
ListDomainsLifecycleStateTerminated ListDomainsLifecycleStateEnum = "TERMINATED"
)
func GetListDomainsLifecycleStateEnumValues() []ListDomainsLifecycleStateEnum
GetListDomainsLifecycleStateEnumValues Enumerates the set of values for ListDomainsLifecycleStateEnum
func GetMappingListDomainsLifecycleStateEnum(val string) (ListDomainsLifecycleStateEnum, bool)
GetMappingListDomainsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListDomainsRequest wrapper for the ListDomains operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListDomains.go.html to see an example of how to use ListDomainsRequest.
type ListDomainsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The domain OCID.
DomainId *string `mandatory:"false" contributesTo:"query" name:"domainId"`
// The lifecycle state of the resource.
LifecycleState ListDomainsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The status of the domain.
Status DomainStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// A filter to return only resources that exactly match the name given.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order can be provided.
// * The default order for timeCreated is descending.
// * The default order for displayName is ascending.
// * If no value is specified, timeCreated is the default.
SortBy ListDomainsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, whether 'asc' or 'desc'.
SortOrder ListDomainsSortOrderEnum `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 ListDomainsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDomainsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDomainsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDomainsRequest) String() string
func (request ListDomainsRequest) 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
ListDomainsResponse wrapper for the ListDomains operation
type ListDomainsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DomainCollection instances
DomainCollection `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 ListDomainsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDomainsResponse) String() string
ListDomainsSortByEnum Enum with underlying type: string
type ListDomainsSortByEnum string
Set of constants representing the allowable values for ListDomainsSortByEnum
const (
ListDomainsSortByTimecreated ListDomainsSortByEnum = "timeCreated"
ListDomainsSortByDisplayname ListDomainsSortByEnum = "displayName"
)
func GetListDomainsSortByEnumValues() []ListDomainsSortByEnum
GetListDomainsSortByEnumValues Enumerates the set of values for ListDomainsSortByEnum
func GetMappingListDomainsSortByEnum(val string) (ListDomainsSortByEnum, bool)
GetMappingListDomainsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDomainsSortOrderEnum Enum with underlying type: string
type ListDomainsSortOrderEnum string
Set of constants representing the allowable values for ListDomainsSortOrderEnum
const (
ListDomainsSortOrderAsc ListDomainsSortOrderEnum = "ASC"
ListDomainsSortOrderDesc ListDomainsSortOrderEnum = "DESC"
)
func GetListDomainsSortOrderEnumValues() []ListDomainsSortOrderEnum
GetListDomainsSortOrderEnumValues Enumerates the set of values for ListDomainsSortOrderEnum
func GetMappingListDomainsSortOrderEnum(val string) (ListDomainsSortOrderEnum, bool)
GetMappingListDomainsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListLinksLifecycleStateEnum Enum with underlying type: string
type ListLinksLifecycleStateEnum string
Set of constants representing the allowable values for ListLinksLifecycleStateEnum
const (
ListLinksLifecycleStateCreating ListLinksLifecycleStateEnum = "CREATING"
ListLinksLifecycleStateActive ListLinksLifecycleStateEnum = "ACTIVE"
ListLinksLifecycleStateInactive ListLinksLifecycleStateEnum = "INACTIVE"
ListLinksLifecycleStateUpdating ListLinksLifecycleStateEnum = "UPDATING"
ListLinksLifecycleStateFailed ListLinksLifecycleStateEnum = "FAILED"
ListLinksLifecycleStateTerminated ListLinksLifecycleStateEnum = "TERMINATED"
)
func GetListLinksLifecycleStateEnumValues() []ListLinksLifecycleStateEnum
GetListLinksLifecycleStateEnumValues Enumerates the set of values for ListLinksLifecycleStateEnum
func GetMappingListLinksLifecycleStateEnum(val string) (ListLinksLifecycleStateEnum, bool)
GetMappingListLinksLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListLinksRequest wrapper for the ListLinks operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListLinks.go.html to see an example of how to use ListLinksRequest.
type ListLinksRequest struct {
// The ID of the parent tenancy this link is associated with.
ParentTenancyId *string `mandatory:"false" contributesTo:"query" name:"parentTenancyId"`
// The ID of the child tenancy this link is associated with.
ChildTenancyId *string `mandatory:"false" contributesTo:"query" name:"childTenancyId"`
// The lifecycle state of the resource.
LifecycleState ListLinksLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, whether 'asc' or 'desc'.
SortOrder ListLinksSortOrderEnum `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 ListLinksRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListLinksRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListLinksRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListLinksRequest) String() string
func (request ListLinksRequest) 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
ListLinksResponse wrapper for the ListLinks operation
type ListLinksResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of LinkCollection instances
LinkCollection `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 ListLinksResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListLinksResponse) String() string
ListLinksSortOrderEnum Enum with underlying type: string
type ListLinksSortOrderEnum string
Set of constants representing the allowable values for ListLinksSortOrderEnum
const (
ListLinksSortOrderAsc ListLinksSortOrderEnum = "ASC"
ListLinksSortOrderDesc ListLinksSortOrderEnum = "DESC"
)
func GetListLinksSortOrderEnumValues() []ListLinksSortOrderEnum
GetListLinksSortOrderEnumValues Enumerates the set of values for ListLinksSortOrderEnum
func GetMappingListLinksSortOrderEnum(val string) (ListLinksSortOrderEnum, bool)
GetMappingListLinksSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListOrganizationTenanciesRequest wrapper for the ListOrganizationTenancies operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListOrganizationTenancies.go.html to see an example of how to use ListOrganizationTenanciesRequest.
type ListOrganizationTenanciesRequest struct {
// OCID of the organization.
OrganizationId *string `mandatory:"true" contributesTo:"path" name:"organizationId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListOrganizationTenanciesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListOrganizationTenanciesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListOrganizationTenanciesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListOrganizationTenanciesRequest) String() string
func (request ListOrganizationTenanciesRequest) 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
ListOrganizationTenanciesResponse wrapper for the ListOrganizationTenancies operation
type ListOrganizationTenanciesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of OrganizationTenancyCollection instances
OrganizationTenancyCollection `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 ListOrganizationTenanciesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListOrganizationTenanciesResponse) String() string
ListOrganizationsRequest wrapper for the ListOrganizations operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListOrganizations.go.html to see an example of how to use ListOrganizationsRequest.
type ListOrganizationsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListOrganizationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListOrganizationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListOrganizationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListOrganizationsRequest) String() string
func (request ListOrganizationsRequest) 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
ListOrganizationsResponse wrapper for the ListOrganizations operation
type ListOrganizationsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of OrganizationCollection instances
OrganizationCollection `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 ListOrganizationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListOrganizationsResponse) String() string
ListRecipientInvitationsLifecycleStateEnum Enum with underlying type: string
type ListRecipientInvitationsLifecycleStateEnum string
Set of constants representing the allowable values for ListRecipientInvitationsLifecycleStateEnum
const (
ListRecipientInvitationsLifecycleStateCreating ListRecipientInvitationsLifecycleStateEnum = "CREATING"
ListRecipientInvitationsLifecycleStateActive ListRecipientInvitationsLifecycleStateEnum = "ACTIVE"
ListRecipientInvitationsLifecycleStateInactive ListRecipientInvitationsLifecycleStateEnum = "INACTIVE"
ListRecipientInvitationsLifecycleStateUpdating ListRecipientInvitationsLifecycleStateEnum = "UPDATING"
ListRecipientInvitationsLifecycleStateFailed ListRecipientInvitationsLifecycleStateEnum = "FAILED"
ListRecipientInvitationsLifecycleStateTerminated ListRecipientInvitationsLifecycleStateEnum = "TERMINATED"
)
func GetListRecipientInvitationsLifecycleStateEnumValues() []ListRecipientInvitationsLifecycleStateEnum
GetListRecipientInvitationsLifecycleStateEnumValues Enumerates the set of values for ListRecipientInvitationsLifecycleStateEnum
func GetMappingListRecipientInvitationsLifecycleStateEnum(val string) (ListRecipientInvitationsLifecycleStateEnum, bool)
GetMappingListRecipientInvitationsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListRecipientInvitationsRequest wrapper for the ListRecipientInvitations operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListRecipientInvitations.go.html to see an example of how to use ListRecipientInvitationsRequest.
type ListRecipientInvitationsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The tenancy that sent the invitation.
SenderTenancyId *string `mandatory:"false" contributesTo:"query" name:"senderTenancyId"`
// The lifecycle state of the resource.
LifecycleState ListRecipientInvitationsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The status of the recipient invitation.
Status ListRecipientInvitationsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// 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 ListRecipientInvitationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRecipientInvitationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRecipientInvitationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRecipientInvitationsRequest) String() string
func (request ListRecipientInvitationsRequest) 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
ListRecipientInvitationsResponse wrapper for the ListRecipientInvitations operation
type ListRecipientInvitationsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of RecipientInvitationCollection instances
RecipientInvitationCollection `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 ListRecipientInvitationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRecipientInvitationsResponse) String() string
ListRecipientInvitationsStatusEnum Enum with underlying type: string
type ListRecipientInvitationsStatusEnum string
Set of constants representing the allowable values for ListRecipientInvitationsStatusEnum
const (
ListRecipientInvitationsStatusPending ListRecipientInvitationsStatusEnum = "PENDING"
ListRecipientInvitationsStatusCanceled ListRecipientInvitationsStatusEnum = "CANCELED"
ListRecipientInvitationsStatusAccepted ListRecipientInvitationsStatusEnum = "ACCEPTED"
ListRecipientInvitationsStatusIgnored ListRecipientInvitationsStatusEnum = "IGNORED"
ListRecipientInvitationsStatusExpired ListRecipientInvitationsStatusEnum = "EXPIRED"
ListRecipientInvitationsStatusFailed ListRecipientInvitationsStatusEnum = "FAILED"
)
func GetListRecipientInvitationsStatusEnumValues() []ListRecipientInvitationsStatusEnum
GetListRecipientInvitationsStatusEnumValues Enumerates the set of values for ListRecipientInvitationsStatusEnum
func GetMappingListRecipientInvitationsStatusEnum(val string) (ListRecipientInvitationsStatusEnum, bool)
GetMappingListRecipientInvitationsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
ListSenderInvitationsLifecycleStateEnum Enum with underlying type: string
type ListSenderInvitationsLifecycleStateEnum string
Set of constants representing the allowable values for ListSenderInvitationsLifecycleStateEnum
const (
ListSenderInvitationsLifecycleStateCreating ListSenderInvitationsLifecycleStateEnum = "CREATING"
ListSenderInvitationsLifecycleStateActive ListSenderInvitationsLifecycleStateEnum = "ACTIVE"
ListSenderInvitationsLifecycleStateInactive ListSenderInvitationsLifecycleStateEnum = "INACTIVE"
ListSenderInvitationsLifecycleStateUpdating ListSenderInvitationsLifecycleStateEnum = "UPDATING"
ListSenderInvitationsLifecycleStateFailed ListSenderInvitationsLifecycleStateEnum = "FAILED"
ListSenderInvitationsLifecycleStateTerminated ListSenderInvitationsLifecycleStateEnum = "TERMINATED"
)
func GetListSenderInvitationsLifecycleStateEnumValues() []ListSenderInvitationsLifecycleStateEnum
GetListSenderInvitationsLifecycleStateEnumValues Enumerates the set of values for ListSenderInvitationsLifecycleStateEnum
func GetMappingListSenderInvitationsLifecycleStateEnum(val string) (ListSenderInvitationsLifecycleStateEnum, bool)
GetMappingListSenderInvitationsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListSenderInvitationsRequest wrapper for the ListSenderInvitations operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListSenderInvitations.go.html to see an example of how to use ListSenderInvitationsRequest.
type ListSenderInvitationsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The tenancy that the invitation is addressed to.
RecipientTenancyId *string `mandatory:"false" contributesTo:"query" name:"recipientTenancyId"`
// The lifecycle state of the resource.
LifecycleState ListSenderInvitationsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The status of the sender invitation.
Status ListSenderInvitationsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order can be provided.
// * The default order for timeCreated is descending.
// * The default order for displayName is ascending.
// * If no value is specified, timeCreated is the default.
SortBy ListSenderInvitationsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, whether 'asc' or 'desc'.
SortOrder ListSenderInvitationsSortOrderEnum `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 ListSenderInvitationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSenderInvitationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSenderInvitationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSenderInvitationsRequest) String() string
func (request ListSenderInvitationsRequest) 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
ListSenderInvitationsResponse wrapper for the ListSenderInvitations operation
type ListSenderInvitationsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of SenderInvitationCollection instances
SenderInvitationCollection `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 ListSenderInvitationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSenderInvitationsResponse) String() string
ListSenderInvitationsSortByEnum Enum with underlying type: string
type ListSenderInvitationsSortByEnum string
Set of constants representing the allowable values for ListSenderInvitationsSortByEnum
const (
ListSenderInvitationsSortByTimecreated ListSenderInvitationsSortByEnum = "timeCreated"
ListSenderInvitationsSortByDisplayname ListSenderInvitationsSortByEnum = "displayName"
)
func GetListSenderInvitationsSortByEnumValues() []ListSenderInvitationsSortByEnum
GetListSenderInvitationsSortByEnumValues Enumerates the set of values for ListSenderInvitationsSortByEnum
func GetMappingListSenderInvitationsSortByEnum(val string) (ListSenderInvitationsSortByEnum, bool)
GetMappingListSenderInvitationsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListSenderInvitationsSortOrderEnum Enum with underlying type: string
type ListSenderInvitationsSortOrderEnum string
Set of constants representing the allowable values for ListSenderInvitationsSortOrderEnum
const (
ListSenderInvitationsSortOrderAsc ListSenderInvitationsSortOrderEnum = "ASC"
ListSenderInvitationsSortOrderDesc ListSenderInvitationsSortOrderEnum = "DESC"
)
func GetListSenderInvitationsSortOrderEnumValues() []ListSenderInvitationsSortOrderEnum
GetListSenderInvitationsSortOrderEnumValues Enumerates the set of values for ListSenderInvitationsSortOrderEnum
func GetMappingListSenderInvitationsSortOrderEnum(val string) (ListSenderInvitationsSortOrderEnum, bool)
GetMappingListSenderInvitationsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListSenderInvitationsStatusEnum Enum with underlying type: string
type ListSenderInvitationsStatusEnum string
Set of constants representing the allowable values for ListSenderInvitationsStatusEnum
const (
ListSenderInvitationsStatusPending ListSenderInvitationsStatusEnum = "PENDING"
ListSenderInvitationsStatusCanceled ListSenderInvitationsStatusEnum = "CANCELED"
ListSenderInvitationsStatusAccepted ListSenderInvitationsStatusEnum = "ACCEPTED"
ListSenderInvitationsStatusExpired ListSenderInvitationsStatusEnum = "EXPIRED"
ListSenderInvitationsStatusFailed ListSenderInvitationsStatusEnum = "FAILED"
)
func GetListSenderInvitationsStatusEnumValues() []ListSenderInvitationsStatusEnum
GetListSenderInvitationsStatusEnumValues Enumerates the set of values for ListSenderInvitationsStatusEnum
func GetMappingListSenderInvitationsStatusEnum(val string) (ListSenderInvitationsStatusEnum, bool)
GetMappingListSenderInvitationsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
ListSubscriptionLineItemsRequest wrapper for the ListSubscriptionLineItems operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListSubscriptionLineItems.go.html to see an example of how to use ListSubscriptionLineItemsRequest.
type ListSubscriptionLineItemsRequest struct {
// OCID of the subscription.
SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, whether 'asc' or 'desc'.
SortOrder ListSubscriptionLineItemsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided.
// * The default order for timeCreated is descending.
// * The default order for displayName is ascending.
// * If no value is specified, timeCreated is the default.
SortBy ListSubscriptionLineItemsSortByEnum `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 ListSubscriptionLineItemsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSubscriptionLineItemsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSubscriptionLineItemsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSubscriptionLineItemsRequest) String() string
func (request ListSubscriptionLineItemsRequest) 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
ListSubscriptionLineItemsResponse wrapper for the ListSubscriptionLineItems operation
type ListSubscriptionLineItemsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of SubscriptionLineItemCollection instances
SubscriptionLineItemCollection `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 ListSubscriptionLineItemsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSubscriptionLineItemsResponse) String() string
ListSubscriptionLineItemsSortByEnum Enum with underlying type: string
type ListSubscriptionLineItemsSortByEnum string
Set of constants representing the allowable values for ListSubscriptionLineItemsSortByEnum
const (
ListSubscriptionLineItemsSortByTimecreated ListSubscriptionLineItemsSortByEnum = "timeCreated"
ListSubscriptionLineItemsSortByDisplayname ListSubscriptionLineItemsSortByEnum = "displayName"
)
func GetListSubscriptionLineItemsSortByEnumValues() []ListSubscriptionLineItemsSortByEnum
GetListSubscriptionLineItemsSortByEnumValues Enumerates the set of values for ListSubscriptionLineItemsSortByEnum
func GetMappingListSubscriptionLineItemsSortByEnum(val string) (ListSubscriptionLineItemsSortByEnum, bool)
GetMappingListSubscriptionLineItemsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListSubscriptionLineItemsSortOrderEnum Enum with underlying type: string
type ListSubscriptionLineItemsSortOrderEnum string
Set of constants representing the allowable values for ListSubscriptionLineItemsSortOrderEnum
const (
ListSubscriptionLineItemsSortOrderAsc ListSubscriptionLineItemsSortOrderEnum = "ASC"
ListSubscriptionLineItemsSortOrderDesc ListSubscriptionLineItemsSortOrderEnum = "DESC"
)
func GetListSubscriptionLineItemsSortOrderEnumValues() []ListSubscriptionLineItemsSortOrderEnum
GetListSubscriptionLineItemsSortOrderEnumValues Enumerates the set of values for ListSubscriptionLineItemsSortOrderEnum
func GetMappingListSubscriptionLineItemsSortOrderEnum(val string) (ListSubscriptionLineItemsSortOrderEnum, bool)
GetMappingListSubscriptionLineItemsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListSubscriptionMappingsRequest wrapper for the ListSubscriptionMappings operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListSubscriptionMappings.go.html to see an example of how to use ListSubscriptionMappingsRequest.
type ListSubscriptionMappingsRequest struct {
// OCID of the subscription.
SubscriptionId *string `mandatory:"true" contributesTo:"query" name:"subscriptionId"`
// A unique ID for subscription and tenancy mapping.
SubscriptionMappingId *string `mandatory:"false" contributesTo:"query" name:"subscriptionMappingId"`
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// The lifecycle state of the resource.
LifecycleState SubscriptionMappingLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, whether 'asc' or 'desc'.
SortOrder ListSubscriptionMappingsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided.
// * The default order for timeCreated is descending.
// * The default order for displayName is ascending.
// * If no value is specified, timeCreated is the default.
SortBy ListSubscriptionMappingsSortByEnum `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 ListSubscriptionMappingsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSubscriptionMappingsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSubscriptionMappingsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSubscriptionMappingsRequest) String() string
func (request ListSubscriptionMappingsRequest) 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
ListSubscriptionMappingsResponse wrapper for the ListSubscriptionMappings operation
type ListSubscriptionMappingsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of SubscriptionMappingCollection instances
SubscriptionMappingCollection `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 ListSubscriptionMappingsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSubscriptionMappingsResponse) String() string
ListSubscriptionMappingsSortByEnum Enum with underlying type: string
type ListSubscriptionMappingsSortByEnum string
Set of constants representing the allowable values for ListSubscriptionMappingsSortByEnum
const (
ListSubscriptionMappingsSortByTimecreated ListSubscriptionMappingsSortByEnum = "timeCreated"
ListSubscriptionMappingsSortByDisplayname ListSubscriptionMappingsSortByEnum = "displayName"
)
func GetListSubscriptionMappingsSortByEnumValues() []ListSubscriptionMappingsSortByEnum
GetListSubscriptionMappingsSortByEnumValues Enumerates the set of values for ListSubscriptionMappingsSortByEnum
func GetMappingListSubscriptionMappingsSortByEnum(val string) (ListSubscriptionMappingsSortByEnum, bool)
GetMappingListSubscriptionMappingsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListSubscriptionMappingsSortOrderEnum Enum with underlying type: string
type ListSubscriptionMappingsSortOrderEnum string
Set of constants representing the allowable values for ListSubscriptionMappingsSortOrderEnum
const (
ListSubscriptionMappingsSortOrderAsc ListSubscriptionMappingsSortOrderEnum = "ASC"
ListSubscriptionMappingsSortOrderDesc ListSubscriptionMappingsSortOrderEnum = "DESC"
)
func GetListSubscriptionMappingsSortOrderEnumValues() []ListSubscriptionMappingsSortOrderEnum
GetListSubscriptionMappingsSortOrderEnumValues Enumerates the set of values for ListSubscriptionMappingsSortOrderEnum
func GetMappingListSubscriptionMappingsSortOrderEnum(val string) (ListSubscriptionMappingsSortOrderEnum, bool)
GetMappingListSubscriptionMappingsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListSubscriptionsEntityVersionEnum Enum with underlying type: string
type ListSubscriptionsEntityVersionEnum string
Set of constants representing the allowable values for ListSubscriptionsEntityVersionEnum
const (
ListSubscriptionsEntityVersionV1 ListSubscriptionsEntityVersionEnum = "V1"
ListSubscriptionsEntityVersionV2 ListSubscriptionsEntityVersionEnum = "V2"
)
func GetListSubscriptionsEntityVersionEnumValues() []ListSubscriptionsEntityVersionEnum
GetListSubscriptionsEntityVersionEnumValues Enumerates the set of values for ListSubscriptionsEntityVersionEnum
func GetMappingListSubscriptionsEntityVersionEnum(val string) (ListSubscriptionsEntityVersionEnum, bool)
GetMappingListSubscriptionsEntityVersionEnum performs case Insensitive comparison on enum value and return the desired enum
ListSubscriptionsRequest wrapper for the ListSubscriptions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListSubscriptions.go.html to see an example of how to use ListSubscriptionsRequest.
type ListSubscriptionsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// The ID of the subscription to which the tenancy is associated.
SubscriptionId *string `mandatory:"false" contributesTo:"query" name:"subscriptionId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, whether 'asc' or 'desc'.
SortOrder ListSubscriptionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be provided.
// * The default order for timeCreated is descending.
// * The default order for displayName is ascending.
// * If no value is specified, timeCreated is the default.
SortBy ListSubscriptionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The version of the subscription entity.
EntityVersion ListSubscriptionsEntityVersionEnum `mandatory:"false" contributesTo:"query" name:"entityVersion" 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 ListSubscriptionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSubscriptionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSubscriptionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSubscriptionsRequest) String() string
func (request ListSubscriptionsRequest) 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
ListSubscriptionsResponse wrapper for the ListSubscriptions operation
type ListSubscriptionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of SubscriptionCollection instances
SubscriptionCollection `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 ListSubscriptionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSubscriptionsResponse) String() string
ListSubscriptionsSortByEnum Enum with underlying type: string
type ListSubscriptionsSortByEnum string
Set of constants representing the allowable values for ListSubscriptionsSortByEnum
const (
ListSubscriptionsSortByTimecreated ListSubscriptionsSortByEnum = "timeCreated"
ListSubscriptionsSortByDisplayname ListSubscriptionsSortByEnum = "displayName"
)
func GetListSubscriptionsSortByEnumValues() []ListSubscriptionsSortByEnum
GetListSubscriptionsSortByEnumValues Enumerates the set of values for ListSubscriptionsSortByEnum
func GetMappingListSubscriptionsSortByEnum(val string) (ListSubscriptionsSortByEnum, bool)
GetMappingListSubscriptionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListSubscriptionsSortOrderEnum Enum with underlying type: string
type ListSubscriptionsSortOrderEnum string
Set of constants representing the allowable values for ListSubscriptionsSortOrderEnum
const (
ListSubscriptionsSortOrderAsc ListSubscriptionsSortOrderEnum = "ASC"
ListSubscriptionsSortOrderDesc ListSubscriptionsSortOrderEnum = "DESC"
)
func GetListSubscriptionsSortOrderEnumValues() []ListSubscriptionsSortOrderEnum
GetListSubscriptionsSortOrderEnumValues Enumerates the set of values for ListSubscriptionsSortOrderEnum
func GetMappingListSubscriptionsSortOrderEnum(val string) (ListSubscriptionsSortOrderEnum, bool)
GetMappingListSubscriptionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, whether '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
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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, whether '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
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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, whether 'asc' or 'desc'.
SortOrder ListWorkRequestsSortOrderEnum `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 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 WorkRequestCollection instances
WorkRequestCollection `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
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
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
const (
OperationTypeCreateSenderInvitation OperationTypeEnum = "CREATE_SENDER_INVITATION"
OperationTypeAcceptRecipientInvitation OperationTypeEnum = "ACCEPT_RECIPIENT_INVITATION"
OperationTypeCancelSenderInvitation OperationTypeEnum = "CANCEL_SENDER_INVITATION"
OperationTypeCompleteOrderActivation OperationTypeEnum = "COMPLETE_ORDER_ACTIVATION"
OperationTypeActivateOrderExistingTenancy OperationTypeEnum = "ACTIVATE_ORDER_EXISTING_TENANCY"
OperationTypeRegisterDomain OperationTypeEnum = "REGISTER_DOMAIN"
OperationTypeReleaseDomain OperationTypeEnum = "RELEASE_DOMAIN"
OperationTypeCreateChildTenancy OperationTypeEnum = "CREATE_CHILD_TENANCY"
OperationTypeAssignDefaultSubscription OperationTypeEnum = "ASSIGN_DEFAULT_SUBSCRIPTION"
OperationTypeManualLinkCreation OperationTypeEnum = "MANUAL_LINK_CREATION"
OperationTypeTerminateOrganizationTenancy OperationTypeEnum = "TERMINATE_ORGANIZATION_TENANCY"
OperationTypeUpdateSaasCapability OperationTypeEnum = "UPDATE_SAAS_CAPABILITY"
OperationTypeSoftTerminateTenancy OperationTypeEnum = "SOFT_TERMINATE_TENANCY"
OperationTypeHardTerminateTenancy OperationTypeEnum = "HARD_TERMINATE_TENANCY"
OperationTypeRestoreTenancy OperationTypeEnum = "RESTORE_TENANCY"
OperationTypeLogTenancyTerminationRequest OperationTypeEnum = "LOG_TENANCY_TERMINATION_REQUEST"
OperationTypeStandaloneTenancyTerminationRequest OperationTypeEnum = "STANDALONE_TENANCY_TERMINATION_REQUEST"
OperationTypeSelfOptIn OperationTypeEnum = "SELF_OPT_IN"
OperationTypeSelfOptOut OperationTypeEnum = "SELF_OPT_OUT"
OperationTypeOrderPayloadsBackfillEtl OperationTypeEnum = "ORDER_PAYLOADS_BACKFILL_ETL"
OperationTypePublishToTopic OperationTypeEnum = "PUBLISH_TO_TOPIC"
OperationTypeTerminateLink OperationTypeEnum = "TERMINATE_LINK"
OperationTypeTransferSubscription OperationTypeEnum = "TRANSFER_SUBSCRIPTION"
)
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
Order Order details.
type Order struct {
// Immutable and unique order number holding customer subscription information.
OrderNumber *string `mandatory:"true" json:"orderNumber"`
// Email address of the administrator who owns the subscription.
AdminEmail *string `mandatory:"true" json:"adminEmail"`
// State of the order.
OrderState *string `mandatory:"true" json:"orderState"`
// Array of subscriptions associated with the order.
Subscriptions []SubscriptionInfo `mandatory:"true" json:"subscriptions"`
// Order's data center region.
DataCenterRegion *string `mandatory:"false" json:"dataCenterRegion"`
}
func (m Order) String() string
func (m Order) 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
OrdersClient a client for Orders
type OrdersClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewOrdersClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client OrdersClient, err error)
NewOrdersClientWithConfigurationProvider Creates a new default Orders client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewOrdersClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client OrdersClient, err error)
NewOrdersClientWithOboToken Creates a new default Orders 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 OrdersClient) ActivateOrder(ctx context.Context, request ActivateOrderRequest) (response ActivateOrderResponse, err error)
ActivateOrder Triggers an order activation workflow on behalf of the tenant, given by compartment ID in the body.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ActivateOrder.go.html to see an example of how to use ActivateOrder API.
func (client *OrdersClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client OrdersClient) GetOrder(ctx context.Context, request GetOrderRequest) (response GetOrderResponse, err error)
GetOrder Returns the order details given by the order ID in the JWT.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetOrder.go.html to see an example of how to use GetOrder API.
func (client *OrdersClient) SetRegion(region string)
SetRegion overrides the region of this client.
Organization An organization entity.
type Organization struct {
// OCID of the organization.
Id *string `mandatory:"true" json:"id"`
// OCID of the compartment containing the organization. Always a tenancy OCID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// OCID of the default Universal Credits Model subscription. Any tenancy joining the organization will automatically get assigned this subscription, if a subscription is not explictly assigned.
DefaultUcmSubscriptionId *string `mandatory:"true" json:"defaultUcmSubscriptionId"`
// Lifecycle state of the organization.
LifecycleState OrganizationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Date and time when the organization was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A display name for the organization. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The name of the tenancy that is the organization parent.
ParentName *string `mandatory:"false" json:"parentName"`
// Date and time when the organization was last updated.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m Organization) String() string
func (m Organization) 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
OrganizationClient a client for Organization
type OrganizationClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewOrganizationClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client OrganizationClient, err error)
NewOrganizationClientWithConfigurationProvider Creates a new default Organization client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewOrganizationClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client OrganizationClient, err error)
NewOrganizationClientWithOboToken Creates a new default Organization 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 OrganizationClient) ApproveOrganizationTenancyForTransfer(ctx context.Context, request ApproveOrganizationTenancyForTransferRequest) (response ApproveOrganizationTenancyForTransferResponse, err error)
ApproveOrganizationTenancyForTransfer Approve an organization's child tenancy for transfer.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ApproveOrganizationTenancyForTransfer.go.html to see an example of how to use ApproveOrganizationTenancyForTransfer API.
func (client *OrganizationClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client OrganizationClient) CreateChildTenancy(ctx context.Context, request CreateChildTenancyRequest) (response CreateChildTenancyResponse, err error)
CreateChildTenancy Creates a child tenancy asynchronously.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/CreateChildTenancy.go.html to see an example of how to use CreateChildTenancy API.
func (client OrganizationClient) DeleteOrganizationTenancy(ctx context.Context, request DeleteOrganizationTenancyRequest) (response DeleteOrganizationTenancyResponse, err error)
DeleteOrganizationTenancy If certain validations are successful, initiate tenancy termination.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/DeleteOrganizationTenancy.go.html to see an example of how to use DeleteOrganizationTenancy API.
func (client OrganizationClient) GetOrganization(ctx context.Context, request GetOrganizationRequest) (response GetOrganizationResponse, err error)
GetOrganization Gets information about the organization.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetOrganization.go.html to see an example of how to use GetOrganization API.
func (client OrganizationClient) GetOrganizationTenancy(ctx context.Context, request GetOrganizationTenancyRequest) (response GetOrganizationTenancyResponse, err error)
GetOrganizationTenancy Gets information about the organization's tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetOrganizationTenancy.go.html to see an example of how to use GetOrganizationTenancy API.
func (client OrganizationClient) ListOrganizationTenancies(ctx context.Context, request ListOrganizationTenanciesRequest) (response ListOrganizationTenanciesResponse, err error)
ListOrganizationTenancies Gets a list of tenancies in the organization.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListOrganizationTenancies.go.html to see an example of how to use ListOrganizationTenancies API.
func (client OrganizationClient) ListOrganizations(ctx context.Context, request ListOrganizationsRequest) (response ListOrganizationsResponse, err error)
ListOrganizations Lists organizations associated with the caller.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListOrganizations.go.html to see an example of how to use ListOrganizations API.
func (client OrganizationClient) RestoreOrganizationTenancy(ctx context.Context, request RestoreOrganizationTenancyRequest) (response RestoreOrganizationTenancyResponse, err error)
RestoreOrganizationTenancy An asynchronous API to restore a tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/RestoreOrganizationTenancy.go.html to see an example of how to use RestoreOrganizationTenancy API.
func (client *OrganizationClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client OrganizationClient) UnapproveOrganizationTenancyForTransfer(ctx context.Context, request UnapproveOrganizationTenancyForTransferRequest) (response UnapproveOrganizationTenancyForTransferResponse, err error)
UnapproveOrganizationTenancyForTransfer Cancel an organization's child tenancy for transfer.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/UnapproveOrganizationTenancyForTransfer.go.html to see an example of how to use UnapproveOrganizationTenancyForTransfer API.
func (client OrganizationClient) UpdateOrganization(ctx context.Context, request UpdateOrganizationRequest) (response UpdateOrganizationResponse, err error)
UpdateOrganization Map the default subscription to the organization.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/UpdateOrganization.go.html to see an example of how to use UpdateOrganization API.
OrganizationCollection Result of a query request for a list of organizations. Contains OrganizationSummary items.
type OrganizationCollection struct {
// Array containing OrganizationSummary items.
Items []OrganizationSummary `mandatory:"true" json:"items"`
}
func (m OrganizationCollection) String() string
func (m OrganizationCollection) 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
OrganizationLifecycleStateEnum Enum with underlying type: string
type OrganizationLifecycleStateEnum string
Set of constants representing the allowable values for OrganizationLifecycleStateEnum
const (
OrganizationLifecycleStateCreating OrganizationLifecycleStateEnum = "CREATING"
OrganizationLifecycleStateActive OrganizationLifecycleStateEnum = "ACTIVE"
OrganizationLifecycleStateUpdating OrganizationLifecycleStateEnum = "UPDATING"
OrganizationLifecycleStateDeleting OrganizationLifecycleStateEnum = "DELETING"
OrganizationLifecycleStateDeleted OrganizationLifecycleStateEnum = "DELETED"
OrganizationLifecycleStateFailed OrganizationLifecycleStateEnum = "FAILED"
)
func GetMappingOrganizationLifecycleStateEnum(val string) (OrganizationLifecycleStateEnum, bool)
GetMappingOrganizationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOrganizationLifecycleStateEnumValues() []OrganizationLifecycleStateEnum
GetOrganizationLifecycleStateEnumValues Enumerates the set of values for OrganizationLifecycleStateEnum
OrganizationSummary An organization entity.
type OrganizationSummary struct {
// OCID of the organization.
Id *string `mandatory:"true" json:"id"`
// OCID of the compartment containing the organization. Always a tenancy OCID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// OCID of the default Universal Credits Model subscription. Any tenancy joining the organization will automatically get assigned this subscription, if a subscription is not explictly assigned.
DefaultUcmSubscriptionId *string `mandatory:"true" json:"defaultUcmSubscriptionId"`
// Lifecycle state of the organization.
LifecycleState OrganizationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Date and time when the organization was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A display name for the organization. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The name of the tenancy that is the organization parent.
ParentName *string `mandatory:"false" json:"parentName"`
// Date and time when the organization was last updated.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// 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 OrganizationSummary) String() string
func (m OrganizationSummary) 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
OrganizationTenancy The information about the organization tenancy.
type OrganizationTenancy struct {
// OCID of the tenancy.
TenancyId *string `mandatory:"true" json:"tenancyId"`
// The governance status of the tenancy.
GovernanceStatus GovernanceStatusEnum `mandatory:"true" json:"governanceStatus"`
// Name of the tenancy.
Name *string `mandatory:"false" json:"name"`
// Lifecycle state of the organization tenancy.
LifecycleState OrganizationTenancyLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Role of the organization tenancy.
Role OrganizationTenancyRoleEnum `mandatory:"false" json:"role,omitempty"`
// Date and time when the tenancy joined the organization.
TimeJoined *common.SDKTime `mandatory:"false" json:"timeJoined"`
// Date and time when the tenancy left the organization.
TimeLeft *common.SDKTime `mandatory:"false" json:"timeLeft"`
// Parameter to indicate the tenancy is approved for transfer to another organization.
IsApprovedForTransfer *bool `mandatory:"false" json:"isApprovedForTransfer"`
}
func (m OrganizationTenancy) String() string
func (m OrganizationTenancy) 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
OrganizationTenancyCollection Result of a query request for a list of organization tenancies. Contains OrganizationTenancySummary items.
type OrganizationTenancyCollection struct {
// Array containing OrganizationTenancySummary items.
Items []OrganizationTenancySummary `mandatory:"true" json:"items"`
}
func (m OrganizationTenancyCollection) String() string
func (m OrganizationTenancyCollection) 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
OrganizationTenancyLifecycleStateEnum Enum with underlying type: string
type OrganizationTenancyLifecycleStateEnum string
Set of constants representing the allowable values for OrganizationTenancyLifecycleStateEnum
const (
OrganizationTenancyLifecycleStateCreating OrganizationTenancyLifecycleStateEnum = "CREATING"
OrganizationTenancyLifecycleStateActive OrganizationTenancyLifecycleStateEnum = "ACTIVE"
OrganizationTenancyLifecycleStateInactive OrganizationTenancyLifecycleStateEnum = "INACTIVE"
OrganizationTenancyLifecycleStateDeleted OrganizationTenancyLifecycleStateEnum = "DELETED"
OrganizationTenancyLifecycleStateFailed OrganizationTenancyLifecycleStateEnum = "FAILED"
OrganizationTenancyLifecycleStateDeleting OrganizationTenancyLifecycleStateEnum = "DELETING"
)
func GetMappingOrganizationTenancyLifecycleStateEnum(val string) (OrganizationTenancyLifecycleStateEnum, bool)
GetMappingOrganizationTenancyLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOrganizationTenancyLifecycleStateEnumValues() []OrganizationTenancyLifecycleStateEnum
GetOrganizationTenancyLifecycleStateEnumValues Enumerates the set of values for OrganizationTenancyLifecycleStateEnum
OrganizationTenancyRoleEnum Enum with underlying type: string
type OrganizationTenancyRoleEnum string
Set of constants representing the allowable values for OrganizationTenancyRoleEnum
const (
OrganizationTenancyRoleParent OrganizationTenancyRoleEnum = "PARENT"
OrganizationTenancyRoleChild OrganizationTenancyRoleEnum = "CHILD"
OrganizationTenancyRoleNone OrganizationTenancyRoleEnum = "NONE"
)
func GetMappingOrganizationTenancyRoleEnum(val string) (OrganizationTenancyRoleEnum, bool)
GetMappingOrganizationTenancyRoleEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOrganizationTenancyRoleEnumValues() []OrganizationTenancyRoleEnum
GetOrganizationTenancyRoleEnumValues Enumerates the set of values for OrganizationTenancyRoleEnum
OrganizationTenancySummary An organization tenancy summary entity.
type OrganizationTenancySummary struct {
// OCID of the tenancy.
TenancyId *string `mandatory:"true" json:"tenancyId"`
// The governance status of the tenancy.
GovernanceStatus GovernanceStatusEnum `mandatory:"true" json:"governanceStatus"`
// Name of the tenancy.
Name *string `mandatory:"false" json:"name"`
// Lifecycle state of the organization tenancy.
LifecycleState OrganizationTenancyLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Role of the organization tenancy.
Role OrganizationTenancyRoleEnum `mandatory:"false" json:"role,omitempty"`
// Date and time when the tenancy joined the organization.
TimeJoined *common.SDKTime `mandatory:"false" json:"timeJoined"`
// Date and time when the tenancy left the organization.
TimeLeft *common.SDKTime `mandatory:"false" json:"timeLeft"`
// Parameter to indicate the tenancy is approved for transfer to another organization.
IsApprovedForTransfer *bool `mandatory:"false" json:"isApprovedForTransfer"`
// 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 OrganizationTenancySummary) String() string
func (m OrganizationTenancySummary) 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
Promotion Promotion information for a subscription.
type Promotion struct {
// Specifies how long the promotion related to the subscription, if any, is valid in duration units.
Duration *int `mandatory:"false" json:"duration"`
// Unit for the duration.
DurationUnit *string `mandatory:"false" json:"durationUnit"`
// If a subscription is present, indicates the total amount of promotional subscription credits.
Amount *float32 `mandatory:"false" json:"amount"`
// If a subscription is present, indicates the current status of the subscription promotion.
Status PromotionStatusEnum `mandatory:"false" json:"status,omitempty"`
// Speficies whether or not the customer intends to pay after the promotion has expired.
IsIntentToPay *bool `mandatory:"false" json:"isIntentToPay"`
// Currency unit associated with the promotion.
CurrencyUnit *string `mandatory:"false" json:"currencyUnit"`
// Date and time when the promotion starts.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// Date and time when the promotion ends.
TimeExpired *common.SDKTime `mandatory:"false" json:"timeExpired"`
}
func (m Promotion) String() string
func (m Promotion) 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
PromotionStatusEnum Enum with underlying type: string
type PromotionStatusEnum string
Set of constants representing the allowable values for PromotionStatusEnum
const (
PromotionStatusInitialized PromotionStatusEnum = "INITIALIZED"
PromotionStatusActive PromotionStatusEnum = "ACTIVE"
PromotionStatusExpired PromotionStatusEnum = "EXPIRED"
)
func GetMappingPromotionStatusEnum(val string) (PromotionStatusEnum, bool)
GetMappingPromotionStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPromotionStatusEnumValues() []PromotionStatusEnum
GetPromotionStatusEnumValues Enumerates the set of values for PromotionStatusEnum
RecipientInvitation The invitation model that the recipient owns.
type RecipientInvitation struct {
// OCID of the recipient invitation.
Id *string `mandatory:"true" json:"id"`
// OCID of the recipient tenancy.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The list of subjects the invitation contains.
Subjects []InvitationSubjectEnum `mandatory:"true" json:"subjects"`
// OCID of the corresponding sender invitation.
SenderInvitationId *string `mandatory:"true" json:"senderInvitationId"`
// OCID of the sender tenancy.
SenderTenancyId *string `mandatory:"true" json:"senderTenancyId"`
// Lifecycle state of the recipient invitation.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Status of the recipient invitation.
Status RecipientInvitationStatusEnum `mandatory:"true" json:"status"`
// Date and time when the recipient invitation was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A user-created name to describe the invitation. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Date and time when the recipient invitation was last updated.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Email address of the recipient.
RecipientEmailAddress *string `mandatory:"false" json:"recipientEmailAddress"`
// 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"`
// 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 RecipientInvitation) String() string
func (m RecipientInvitation) 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
RecipientInvitationClient a client for RecipientInvitation
type RecipientInvitationClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewRecipientInvitationClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client RecipientInvitationClient, err error)
NewRecipientInvitationClientWithConfigurationProvider Creates a new default RecipientInvitation client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewRecipientInvitationClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client RecipientInvitationClient, err error)
NewRecipientInvitationClientWithOboToken Creates a new default RecipientInvitation 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 RecipientInvitationClient) AcceptRecipientInvitation(ctx context.Context, request AcceptRecipientInvitationRequest) (response AcceptRecipientInvitationResponse, err error)
AcceptRecipientInvitation Accepts a recipient invitation.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/AcceptRecipientInvitation.go.html to see an example of how to use AcceptRecipientInvitation API.
func (client *RecipientInvitationClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client RecipientInvitationClient) GetRecipientInvitation(ctx context.Context, request GetRecipientInvitationRequest) (response GetRecipientInvitationResponse, err error)
GetRecipientInvitation Gets information about the recipient invitation.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetRecipientInvitation.go.html to see an example of how to use GetRecipientInvitation API.
func (client RecipientInvitationClient) IgnoreRecipientInvitation(ctx context.Context, request IgnoreRecipientInvitationRequest) (response IgnoreRecipientInvitationResponse, err error)
IgnoreRecipientInvitation Ignores a recipient invitation.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/IgnoreRecipientInvitation.go.html to see an example of how to use IgnoreRecipientInvitation API.
func (client RecipientInvitationClient) ListRecipientInvitations(ctx context.Context, request ListRecipientInvitationsRequest) (response ListRecipientInvitationsResponse, err error)
ListRecipientInvitations Return a (paginated) list of recipient invitations.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListRecipientInvitations.go.html to see an example of how to use ListRecipientInvitations API.
func (client *RecipientInvitationClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client RecipientInvitationClient) UpdateRecipientInvitation(ctx context.Context, request UpdateRecipientInvitationRequest) (response UpdateRecipientInvitationResponse, err error)
UpdateRecipientInvitation Updates the recipient invitation.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/UpdateRecipientInvitation.go.html to see an example of how to use UpdateRecipientInvitation API.
RecipientInvitationCollection Result of a query request for a list of recipient invitations. Contains RecipientInvitationSummary items.
type RecipientInvitationCollection struct {
// Array containing RecipientInvitationSummary items.
Items []RecipientInvitationSummary `mandatory:"true" json:"items"`
}
func (m RecipientInvitationCollection) String() string
func (m RecipientInvitationCollection) 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
RecipientInvitationStatusEnum Enum with underlying type: string
type RecipientInvitationStatusEnum string
Set of constants representing the allowable values for RecipientInvitationStatusEnum
const (
RecipientInvitationStatusPending RecipientInvitationStatusEnum = "PENDING"
RecipientInvitationStatusCanceled RecipientInvitationStatusEnum = "CANCELED"
RecipientInvitationStatusAccepted RecipientInvitationStatusEnum = "ACCEPTED"
RecipientInvitationStatusIgnored RecipientInvitationStatusEnum = "IGNORED"
RecipientInvitationStatusExpired RecipientInvitationStatusEnum = "EXPIRED"
RecipientInvitationStatusFailed RecipientInvitationStatusEnum = "FAILED"
)
func GetMappingRecipientInvitationStatusEnum(val string) (RecipientInvitationStatusEnum, bool)
GetMappingRecipientInvitationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRecipientInvitationStatusEnumValues() []RecipientInvitationStatusEnum
GetRecipientInvitationStatusEnumValues Enumerates the set of values for RecipientInvitationStatusEnum
RecipientInvitationSummary The summary of the invitation model that the recipient owns.
type RecipientInvitationSummary struct {
// OCID of the recipient invitation.
Id *string `mandatory:"true" json:"id"`
// OCID of the recipient tenancy.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-created name to describe the invitation. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The list of subjects the invitation contains.
Subjects []InvitationSubjectEnum `mandatory:"true" json:"subjects"`
// OCID of the corresponding sender invitation.
SenderInvitationId *string `mandatory:"true" json:"senderInvitationId"`
// OCID of the sender tenancy.
SenderTenancyId *string `mandatory:"true" json:"senderTenancyId"`
// Lifecycle state of the recipient invitation.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Status of the recipient invitation.
Status RecipientInvitationStatusEnum `mandatory:"true" json:"status"`
// Date and time when the recipient invitation was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Date and time when the recipient invitation was last updated.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Email address of the recipient.
RecipientEmailAddress *string `mandatory:"false" json:"recipientEmailAddress"`
// 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"`
// 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 RecipientInvitationSummary) String() string
func (m RecipientInvitationSummary) 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
RemoveGovernanceRequest wrapper for the RemoveGovernance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/RemoveGovernance.go.html to see an example of how to use RemoveGovernanceRequest.
type RemoveGovernanceRequest struct {
// OCID of the organization.
OrganizationId *string `mandatory:"true" contributesTo:"path" name:"organizationId"`
// OCID of tenancy that is opting out of governance rules.
OrganizationTenancyId *string `mandatory:"true" contributesTo:"path" name:"organizationTenancyId"`
// 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
// will 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 RemoveGovernanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveGovernanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveGovernanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveGovernanceRequest) String() string
func (request RemoveGovernanceRequest) 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
RemoveGovernanceResponse wrapper for the RemoveGovernance operation
type RemoveGovernanceResponse 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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response RemoveGovernanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveGovernanceResponse) String() string
RestoreOrganizationTenancyRequest wrapper for the RestoreOrganizationTenancy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/RestoreOrganizationTenancy.go.html to see an example of how to use RestoreOrganizationTenancyRequest.
type RestoreOrganizationTenancyRequest struct {
// OCID of the tenancy to be restored.
OrganizationTenancyId *string `mandatory:"true" contributesTo:"path" name:"organizationTenancyId"`
// 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 RestoreOrganizationTenancyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RestoreOrganizationTenancyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RestoreOrganizationTenancyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RestoreOrganizationTenancyRequest) String() string
func (request RestoreOrganizationTenancyRequest) 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
RestoreOrganizationTenancyResponse wrapper for the RestoreOrganizationTenancy operation
type RestoreOrganizationTenancyResponse 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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response RestoreOrganizationTenancyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RestoreOrganizationTenancyResponse) String() string
ReviveWorkflowInstanceDetails The parameters for reviving failed workflow
type ReviveWorkflowInstanceDetails struct {
// Id of failed workflow
WorkflowInstanceId *string `mandatory:"false" json:"workflowInstanceId"`
// Service specific workflow instance name
WorkflowInstanceName *string `mandatory:"false" json:"workflowInstanceName"`
}
func (m ReviveWorkflowInstanceDetails) String() string
func (m ReviveWorkflowInstanceDetails) 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
SenderInvitation The invitation model that the sender owns.
type SenderInvitation struct {
// OCID of the sender invitation.
Id *string `mandatory:"true" json:"id"`
// OCID of the sender tenancy.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The list of subjects the invitation contains.
Subjects []InvitationSubjectEnum `mandatory:"true" json:"subjects"`
// OCID of the recipient tenancy.
RecipientTenancyId *string `mandatory:"true" json:"recipientTenancyId"`
// Lifecycle state of the sender invitation.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Status of the sender invitation.
Status SenderInvitationStatusEnum `mandatory:"true" json:"status"`
// Date and time when the sender invitation was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// OCID of the corresponding recipient invitation.
RecipientInvitationId *string `mandatory:"false" json:"recipientInvitationId"`
// A user-created name to describe the invitation. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Date and time when the sender invitation was last updated.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Email address of the recipient.
RecipientEmailAddress *string `mandatory:"false" json:"recipientEmailAddress"`
// 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"`
// 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 SenderInvitation) String() string
func (m SenderInvitation) 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
SenderInvitationClient a client for SenderInvitation
type SenderInvitationClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewSenderInvitationClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client SenderInvitationClient, err error)
NewSenderInvitationClientWithConfigurationProvider Creates a new default SenderInvitation client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewSenderInvitationClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client SenderInvitationClient, err error)
NewSenderInvitationClientWithOboToken Creates a new default SenderInvitation 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 SenderInvitationClient) CancelSenderInvitation(ctx context.Context, request CancelSenderInvitationRequest) (response CancelSenderInvitationResponse, err error)
CancelSenderInvitation Cancels a sender invitation.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/CancelSenderInvitation.go.html to see an example of how to use CancelSenderInvitation API.
func (client *SenderInvitationClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client SenderInvitationClient) CreateSenderInvitation(ctx context.Context, request CreateSenderInvitationRequest) (response CreateSenderInvitationResponse, err error)
CreateSenderInvitation Creates a sender invitation and asynchronously sends the invitation to the recipient.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/CreateSenderInvitation.go.html to see an example of how to use CreateSenderInvitation API.
func (client SenderInvitationClient) GetSenderInvitation(ctx context.Context, request GetSenderInvitationRequest) (response GetSenderInvitationResponse, err error)
GetSenderInvitation Gets information about the sender invitation.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetSenderInvitation.go.html to see an example of how to use GetSenderInvitation API.
func (client SenderInvitationClient) ListSenderInvitations(ctx context.Context, request ListSenderInvitationsRequest) (response ListSenderInvitationsResponse, err error)
ListSenderInvitations Return a (paginated) list of sender invitations.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListSenderInvitations.go.html to see an example of how to use ListSenderInvitations API.
func (client *SenderInvitationClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client SenderInvitationClient) UpdateSenderInvitation(ctx context.Context, request UpdateSenderInvitationRequest) (response UpdateSenderInvitationResponse, err error)
UpdateSenderInvitation Updates the sender invitation.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/UpdateSenderInvitation.go.html to see an example of how to use UpdateSenderInvitation API.
SenderInvitationCollection Result of a query request for a list of sender invitations. Contains SenderInvitationSummary items.
type SenderInvitationCollection struct {
// Array containing SenderInvitationSummary items.
Items []SenderInvitationSummary `mandatory:"true" json:"items"`
}
func (m SenderInvitationCollection) String() string
func (m SenderInvitationCollection) 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
SenderInvitationStatusEnum Enum with underlying type: string
type SenderInvitationStatusEnum string
Set of constants representing the allowable values for SenderInvitationStatusEnum
const (
SenderInvitationStatusPending SenderInvitationStatusEnum = "PENDING"
SenderInvitationStatusCanceled SenderInvitationStatusEnum = "CANCELED"
SenderInvitationStatusAccepted SenderInvitationStatusEnum = "ACCEPTED"
SenderInvitationStatusExpired SenderInvitationStatusEnum = "EXPIRED"
SenderInvitationStatusFailed SenderInvitationStatusEnum = "FAILED"
)
func GetMappingSenderInvitationStatusEnum(val string) (SenderInvitationStatusEnum, bool)
GetMappingSenderInvitationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSenderInvitationStatusEnumValues() []SenderInvitationStatusEnum
GetSenderInvitationStatusEnumValues Enumerates the set of values for SenderInvitationStatusEnum
SenderInvitationSummary The summary of the invitation model that the sender owns.
type SenderInvitationSummary struct {
// OCID of the sender invitation.
Id *string `mandatory:"true" json:"id"`
// OCID of the sender tenancy.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-created name to describe the invitation. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The list of subjects the invitation contains.
Subjects []InvitationSubjectEnum `mandatory:"true" json:"subjects"`
// OCID of the recipient tenancy.
RecipientTenancyId *string `mandatory:"true" json:"recipientTenancyId"`
// Lifecycle state of the sender invitation.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Status of the sender invitation.
Status SenderInvitationStatusEnum `mandatory:"true" json:"status"`
// Date and time when the sender invitation was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// OCID of the corresponding recipient invitation.
RecipientInvitationId *string `mandatory:"false" json:"recipientInvitationId"`
// Date and time when the sender invitation was last updated.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Email address of the recipient.
RecipientEmailAddress *string `mandatory:"false" json:"recipientEmailAddress"`
// 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"`
// 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 SenderInvitationSummary) String() string
func (m SenderInvitationSummary) 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
Sku A single subscription SKU.
type Sku struct {
// SKU number.
Number *string `mandatory:"false" json:"number"`
// SKU name.
Name *string `mandatory:"false" json:"name"`
// SKU quantity.
Quantity *int `mandatory:"false" json:"quantity"`
}
func (m Sku) String() string
func (m Sku) 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
Subscription Base subscription type, which carries shared properties for any subscription version.
type Subscription interface {
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the subscription.
GetId() *string
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the owning compartment. Always a tenancy OCID.
GetCompartmentId() *string
// The type of subscription, such as 'UCM', 'SAAS', 'ERP', 'CRM'.
GetServiceName() *string
// The date and time of creation, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
GetTimeCreated() *common.SDKTime
// The date and time of update, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
GetTimeUpdated() *common.SDKTime
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
}
SubscriptionClient a client for Subscription
type SubscriptionClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewSubscriptionClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client SubscriptionClient, err error)
NewSubscriptionClientWithConfigurationProvider Creates a new default Subscription client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewSubscriptionClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client SubscriptionClient, err error)
NewSubscriptionClientWithOboToken Creates a new default Subscription 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 *SubscriptionClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client SubscriptionClient) CreateSubscriptionMapping(ctx context.Context, request CreateSubscriptionMappingRequest) (response CreateSubscriptionMappingResponse, err error)
CreateSubscriptionMapping Assign the tenancy record identified by the compartment ID to the given subscription ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/CreateSubscriptionMapping.go.html to see an example of how to use CreateSubscriptionMapping API.
func (client SubscriptionClient) DeleteSubscriptionMapping(ctx context.Context, request DeleteSubscriptionMappingRequest) (response DeleteSubscriptionMappingResponse, err error)
DeleteSubscriptionMapping Delete the subscription mapping details by subscription mapping ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/DeleteSubscriptionMapping.go.html to see an example of how to use DeleteSubscriptionMapping API.
func (client SubscriptionClient) GetAssignedSubscription(ctx context.Context, request GetAssignedSubscriptionRequest) (response GetAssignedSubscriptionResponse, err error)
GetAssignedSubscription Get the assigned subscription details by assigned subscription ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetAssignedSubscription.go.html to see an example of how to use GetAssignedSubscription API.
func (client SubscriptionClient) GetSubscription(ctx context.Context, request GetSubscriptionRequest) (response GetSubscriptionResponse, err error)
GetSubscription Gets the subscription details by subscription ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetSubscription.go.html to see an example of how to use GetSubscription API.
func (client SubscriptionClient) GetSubscriptionMapping(ctx context.Context, request GetSubscriptionMappingRequest) (response GetSubscriptionMappingResponse, err error)
GetSubscriptionMapping Get the subscription mapping details by subscription mapping ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetSubscriptionMapping.go.html to see an example of how to use GetSubscriptionMapping API.
func (client SubscriptionClient) ListAssignedSubscriptionLineItems(ctx context.Context, request ListAssignedSubscriptionLineItemsRequest) (response ListAssignedSubscriptionLineItemsResponse, err error)
ListAssignedSubscriptionLineItems List line item summaries that a assigned subscription owns.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListAssignedSubscriptionLineItems.go.html to see an example of how to use ListAssignedSubscriptionLineItems API. A default retry strategy applies to this operation ListAssignedSubscriptionLineItems()
func (client SubscriptionClient) ListAssignedSubscriptions(ctx context.Context, request ListAssignedSubscriptionsRequest) (response ListAssignedSubscriptionsResponse, err error)
ListAssignedSubscriptions Lists subscriptions that are consumed by the compartment. Only the root compartment is allowed.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListAssignedSubscriptions.go.html to see an example of how to use ListAssignedSubscriptions API.
func (client SubscriptionClient) ListAvailableRegions(ctx context.Context, request ListAvailableRegionsRequest) (response ListAvailableRegionsResponse, err error)
ListAvailableRegions List the available regions based on subscription ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListAvailableRegions.go.html to see an example of how to use ListAvailableRegions API.
func (client SubscriptionClient) ListSubscriptionLineItems(ctx context.Context, request ListSubscriptionLineItemsRequest) (response ListSubscriptionLineItemsResponse, err error)
ListSubscriptionLineItems Lists the line items in a subscription.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListSubscriptionLineItems.go.html to see an example of how to use ListSubscriptionLineItems API. A default retry strategy applies to this operation ListSubscriptionLineItems()
func (client SubscriptionClient) ListSubscriptionMappings(ctx context.Context, request ListSubscriptionMappingsRequest) (response ListSubscriptionMappingsResponse, err error)
ListSubscriptionMappings Lists the subscription mappings for all the subscriptions owned by a given compartmentId. Only the root compartment is allowed.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListSubscriptionMappings.go.html to see an example of how to use ListSubscriptionMappings API.
func (client SubscriptionClient) ListSubscriptions(ctx context.Context, request ListSubscriptionsRequest) (response ListSubscriptionsResponse, err error)
ListSubscriptions List the subscriptions that a compartment owns. Only the root compartment is allowed.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListSubscriptions.go.html to see an example of how to use ListSubscriptions API.
func (client *SubscriptionClient) SetRegion(region string)
SetRegion overrides the region of this client.
SubscriptionCollection List of subscription summaries.
type SubscriptionCollection struct {
// Array containing subscription summary items.
Items []SubscriptionSummary `mandatory:"true" json:"items"`
}
func (m SubscriptionCollection) String() string
func (m *SubscriptionCollection) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m SubscriptionCollection) 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
SubscriptionEntityVersionEnum Enum with underlying type: string
type SubscriptionEntityVersionEnum string
Set of constants representing the allowable values for SubscriptionEntityVersionEnum
const (
SubscriptionEntityVersionV1 SubscriptionEntityVersionEnum = "V1"
SubscriptionEntityVersionV2 SubscriptionEntityVersionEnum = "V2"
)
func GetMappingSubscriptionEntityVersionEnum(val string) (SubscriptionEntityVersionEnum, bool)
GetMappingSubscriptionEntityVersionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSubscriptionEntityVersionEnumValues() []SubscriptionEntityVersionEnum
GetSubscriptionEntityVersionEnumValues Enumerates the set of values for SubscriptionEntityVersionEnum
SubscriptionInfo A single subscription's details.
type SubscriptionInfo struct {
// Subscription ID.
SpmSubscriptionId *string `mandatory:"true" json:"spmSubscriptionId"`
// Subscription service name.
Service *string `mandatory:"true" json:"service"`
// Subscription start date. An RFC 3339-formatted date and time string.
StartDate *common.SDKTime `mandatory:"true" json:"startDate"`
// Subscription end date. An RFC 3339-formatted date and time string.
EndDate *common.SDKTime `mandatory:"true" json:"endDate"`
// List of SKUs the subscription contains.
Skus []Sku `mandatory:"true" json:"skus"`
}
func (m SubscriptionInfo) String() string
func (m SubscriptionInfo) 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
SubscriptionLifecycleStateEnum Enum with underlying type: string
type SubscriptionLifecycleStateEnum string
Set of constants representing the allowable values for SubscriptionLifecycleStateEnum
const (
SubscriptionLifecycleStateNeedsAttention SubscriptionLifecycleStateEnum = "NEEDS_ATTENTION"
SubscriptionLifecycleStateActive SubscriptionLifecycleStateEnum = "ACTIVE"
SubscriptionLifecycleStateInactive SubscriptionLifecycleStateEnum = "INACTIVE"
SubscriptionLifecycleStateFailed SubscriptionLifecycleStateEnum = "FAILED"
SubscriptionLifecycleStateCreating SubscriptionLifecycleStateEnum = "CREATING"
)
func GetMappingSubscriptionLifecycleStateEnum(val string) (SubscriptionLifecycleStateEnum, bool)
GetMappingSubscriptionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSubscriptionLifecycleStateEnumValues() []SubscriptionLifecycleStateEnum
GetSubscriptionLifecycleStateEnumValues Enumerates the set of values for SubscriptionLifecycleStateEnum
SubscriptionLineItemCollection Collection of line item summaries in a subscription.
type SubscriptionLineItemCollection struct {
// Array containing line item summaries in a subscription.
Items []SubscriptionLineItemSummary `mandatory:"true" json:"items"`
}
func (m SubscriptionLineItemCollection) String() string
func (m SubscriptionLineItemCollection) 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
SubscriptionLineItemSummary Summary of line items in a subscription.
type SubscriptionLineItemSummary struct {
// Subscription line item identifier.
Id *string `mandatory:"true" json:"id"`
// Product code.
ProductCode *string `mandatory:"true" json:"productCode"`
// Product number.
Quantity *float32 `mandatory:"true" json:"quantity"`
// Billing model supported by the associated line item.
BillingModel BillingModelEnum `mandatory:"true" json:"billingModel"`
// The time the subscription item and associated products should start. An RFC 3339 formatted date and time string.
TimeStarted *common.SDKTime `mandatory:"true" json:"timeStarted"`
// The time the subscription item and associated products should end. An RFC 3339 formatted date and time string.
TimeEnded *common.SDKTime `mandatory:"true" json:"timeEnded"`
// 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 SubscriptionLineItemSummary) String() string
func (m SubscriptionLineItemSummary) 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
SubscriptionMapping Subscription mapping information.
type SubscriptionMapping struct {
// OCID of the mapping between subscription and compartment identified by the tenancy.
Id *string `mandatory:"true" json:"id"`
// OCID of the subscription.
SubscriptionId *string `mandatory:"true" json:"subscriptionId"`
// OCID of the compartment. Always a tenancy OCID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Denotes if the subscription is explicity assigned to the root compartment or tenancy.
IsExplicitlyAssigned *bool `mandatory:"true" json:"isExplicitlyAssigned"`
// Lifecycle state of the subscriptionMapping.
LifecycleState SubscriptionMappingLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Date-time when subscription mapping was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Date-time when subscription mapping was updated.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Date-time when subscription mapping was terminated.
TimeTerminated *common.SDKTime `mandatory:"false" json:"timeTerminated"`
}
func (m SubscriptionMapping) String() string
func (m SubscriptionMapping) 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
SubscriptionMappingCollection List of subscription mappings.
type SubscriptionMappingCollection struct {
// Array containing subscription mapping items.
Items []SubscriptionMappingSummary `mandatory:"true" json:"items"`
}
func (m SubscriptionMappingCollection) String() string
func (m SubscriptionMappingCollection) 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
SubscriptionMappingLifecycleStateEnum Enum with underlying type: string
type SubscriptionMappingLifecycleStateEnum string
Set of constants representing the allowable values for SubscriptionMappingLifecycleStateEnum
const (
SubscriptionMappingLifecycleStateCreating SubscriptionMappingLifecycleStateEnum = "CREATING"
SubscriptionMappingLifecycleStateActive SubscriptionMappingLifecycleStateEnum = "ACTIVE"
SubscriptionMappingLifecycleStateInactive SubscriptionMappingLifecycleStateEnum = "INACTIVE"
SubscriptionMappingLifecycleStateUpdating SubscriptionMappingLifecycleStateEnum = "UPDATING"
SubscriptionMappingLifecycleStateDeleting SubscriptionMappingLifecycleStateEnum = "DELETING"
SubscriptionMappingLifecycleStateDeleted SubscriptionMappingLifecycleStateEnum = "DELETED"
SubscriptionMappingLifecycleStateFailed SubscriptionMappingLifecycleStateEnum = "FAILED"
)
func GetMappingSubscriptionMappingLifecycleStateEnum(val string) (SubscriptionMappingLifecycleStateEnum, bool)
GetMappingSubscriptionMappingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSubscriptionMappingLifecycleStateEnumValues() []SubscriptionMappingLifecycleStateEnum
GetSubscriptionMappingLifecycleStateEnumValues Enumerates the set of values for SubscriptionMappingLifecycleStateEnum
SubscriptionMappingSummary Subscription mapping information.
type SubscriptionMappingSummary struct {
// OCID of the mapping between subscription and compartment identified by the tenancy.
Id *string `mandatory:"true" json:"id"`
// OCID of the subscription.
SubscriptionId *string `mandatory:"true" json:"subscriptionId"`
// OCID of the compartment. Always a tenancy OCID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Denotes if the subscription is explicity assigned to the root compartment or tenancy.
IsExplicitlyAssigned *bool `mandatory:"true" json:"isExplicitlyAssigned"`
// Lifecycle state of the subscription mapping.
LifecycleState SubscriptionMappingLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Date-time when subscription mapping was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Date-time when subscription mapping was updated.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Date-time when subscription mapping was terminated.
TimeTerminated *common.SDKTime `mandatory:"false" json:"timeTerminated"`
// 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 SubscriptionMappingSummary) String() string
func (m SubscriptionMappingSummary) 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
SubscriptionSku SKU information.
type SubscriptionSku struct {
// Stock Keeping Unit (SKU) ID.
Sku *string `mandatory:"true" json:"sku"`
// Quantity of the stock units.
Quantity *int `mandatory:"false" json:"quantity"`
// Description of the stock units.
Description *string `mandatory:"false" json:"description"`
// Sales order line identifier.
GsiOrderLineId *string `mandatory:"false" json:"gsiOrderLineId"`
// Description of the covered product belonging to this SKU.
LicensePartDescription *string `mandatory:"false" json:"licensePartDescription"`
// Base metric for billing the service.
MetricName *string `mandatory:"false" json:"metricName"`
// Specifies if the SKU is considered as a parent or child.
IsBaseServiceComponent *bool `mandatory:"false" json:"isBaseServiceComponent"`
// Specifies if an additional test instance can be provisioned by the SaaS application.
IsAdditionalInstance *bool `mandatory:"false" json:"isAdditionalInstance"`
// Date and time when the SKU was created.
StartDate *common.SDKTime `mandatory:"false" json:"startDate"`
// Date and time when the SKU ended.
EndDate *common.SDKTime `mandatory:"false" json:"endDate"`
}
func (m SubscriptionSku) String() string
func (m SubscriptionSku) 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
SubscriptionSummary Base subscription summary type, which carries shared properties for any subscription summary version.
type SubscriptionSummary interface {
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the subscription.
GetId() *string
// The Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the owning compartment. Always a tenancy OCID.
GetCompartmentId() *string
// The type of subscription, such as 'CLOUDCM', 'AUTOANALYTICS', 'ERP', 'CRM'.
GetServiceName() *string
// The date and time of creation, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
GetTimeCreated() *common.SDKTime
// The date and time of update, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
GetTimeUpdated() *common.SDKTime
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
GetSystemTags() map[string]map[string]interface{}
}
SubscriptionSummaryEntityVersionEnum Enum with underlying type: string
type SubscriptionSummaryEntityVersionEnum string
Set of constants representing the allowable values for SubscriptionSummaryEntityVersionEnum
const (
SubscriptionSummaryEntityVersionV1 SubscriptionSummaryEntityVersionEnum = "V1"
SubscriptionSummaryEntityVersionV2 SubscriptionSummaryEntityVersionEnum = "V2"
)
func GetMappingSubscriptionSummaryEntityVersionEnum(val string) (SubscriptionSummaryEntityVersionEnum, bool)
GetMappingSubscriptionSummaryEntityVersionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSubscriptionSummaryEntityVersionEnumValues() []SubscriptionSummaryEntityVersionEnum
GetSubscriptionSummaryEntityVersionEnumValues Enumerates the set of values for SubscriptionSummaryEntityVersionEnum
UnapproveOrganizationTenancyForTransferRequest wrapper for the UnapproveOrganizationTenancyForTransfer operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/UnapproveOrganizationTenancyForTransfer.go.html to see an example of how to use UnapproveOrganizationTenancyForTransferRequest.
type UnapproveOrganizationTenancyForTransferRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// OCID of the child tenancy.
OrganizationTenancyId *string `mandatory:"true" contributesTo:"path" name:"organizationTenancyId"`
// 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
// will 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 UnapproveOrganizationTenancyForTransferRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UnapproveOrganizationTenancyForTransferRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UnapproveOrganizationTenancyForTransferRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UnapproveOrganizationTenancyForTransferRequest) String() string
func (request UnapproveOrganizationTenancyForTransferRequest) 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
UnapproveOrganizationTenancyForTransferResponse wrapper for the UnapproveOrganizationTenancyForTransfer operation
type UnapproveOrganizationTenancyForTransferResponse struct {
// The underlying http response
RawResponse *http.Response
// The OrganizationTenancy instance
OrganizationTenancy `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UnapproveOrganizationTenancyForTransferResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UnapproveOrganizationTenancyForTransferResponse) String() string
UpdateDomainDetails The parameters for updating a domain.
type UpdateDomainDetails struct {
// 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 UpdateDomainDetails) String() string
func (m UpdateDomainDetails) 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
UpdateDomainGovernanceDetails The parameters for updating a domain govenance entity.
type UpdateDomainGovernanceDetails struct {
// Email address to be used to notify the user, and that the ONS subscription will be created with. The ONS subscription for the previous email will also be deleted.
SubscriptionEmail *string `mandatory:"false" json:"subscriptionEmail"`
// Indicates whether governance is enabled for this domain.
IsGovernanceEnabled *bool `mandatory:"false" json:"isGovernanceEnabled"`
// 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 UpdateDomainGovernanceDetails) String() string
func (m UpdateDomainGovernanceDetails) 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
UpdateDomainGovernanceRequest wrapper for the UpdateDomainGovernance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/UpdateDomainGovernance.go.html to see an example of how to use UpdateDomainGovernanceRequest.
type UpdateDomainGovernanceRequest struct {
// The domain governance OCID.
DomainGovernanceId *string `mandatory:"true" contributesTo:"path" name:"domainGovernanceId"`
// The information to be updated.
UpdateDomainGovernanceDetails `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 UpdateDomainGovernanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDomainGovernanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDomainGovernanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDomainGovernanceRequest) String() string
func (request UpdateDomainGovernanceRequest) 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
UpdateDomainGovernanceResponse wrapper for the UpdateDomainGovernance operation
type UpdateDomainGovernanceResponse struct {
// The underlying http response
RawResponse *http.Response
// The DomainGovernance instance
DomainGovernance `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateDomainGovernanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDomainGovernanceResponse) String() string
UpdateDomainRequest wrapper for the UpdateDomain operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/UpdateDomain.go.html to see an example of how to use UpdateDomainRequest.
type UpdateDomainRequest struct {
// The domain OCID.
DomainId *string `mandatory:"true" contributesTo:"path" name:"domainId"`
// The information to be updated.
UpdateDomainDetails `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 UpdateDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDomainRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDomainRequest) String() string
func (request UpdateDomainRequest) 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
UpdateDomainResponse wrapper for the UpdateDomain operation
type UpdateDomainResponse struct {
// The underlying http response
RawResponse *http.Response
// The Domain instance
Domain `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateDomainResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDomainResponse) String() string
UpdateOrganizationDetails The parameters for updating an organization.
type UpdateOrganizationDetails struct {
// OCID of the default Universal Credits Model subscription. Any tenancy joining the organization will automatically get assigned this subscription, if a subscription is not explictly assigned.
DefaultUcmSubscriptionId *string `mandatory:"true" json:"defaultUcmSubscriptionId"`
}
func (m UpdateOrganizationDetails) String() string
func (m UpdateOrganizationDetails) 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
UpdateOrganizationRequest wrapper for the UpdateOrganization operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/UpdateOrganization.go.html to see an example of how to use UpdateOrganizationRequest.
type UpdateOrganizationRequest struct {
// OCID of the organization.
OrganizationId *string `mandatory:"true" contributesTo:"path" name:"organizationId"`
// The information to be updated.
UpdateOrganizationDetails `contributesTo:"body"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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
// will 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 UpdateOrganizationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateOrganizationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateOrganizationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateOrganizationRequest) String() string
func (request UpdateOrganizationRequest) 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
UpdateOrganizationResponse wrapper for the UpdateOrganization operation
type UpdateOrganizationResponse 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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateOrganizationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateOrganizationResponse) String() string
UpdateRecipientInvitationDetails The parameters for updating a recipient invitation.
type UpdateRecipientInvitationDetails struct {
// A user-created name to describe the invitation. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// 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 UpdateRecipientInvitationDetails) String() string
func (m UpdateRecipientInvitationDetails) 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
UpdateRecipientInvitationRequest wrapper for the UpdateRecipientInvitation operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/UpdateRecipientInvitation.go.html to see an example of how to use UpdateRecipientInvitationRequest.
type UpdateRecipientInvitationRequest struct {
// OCID of the recipient invitation to update.
RecipientInvitationId *string `mandatory:"true" contributesTo:"path" name:"recipientInvitationId"`
// The information to be updated.
UpdateRecipientInvitationDetails `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 UpdateRecipientInvitationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateRecipientInvitationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateRecipientInvitationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateRecipientInvitationRequest) String() string
func (request UpdateRecipientInvitationRequest) 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
UpdateRecipientInvitationResponse wrapper for the UpdateRecipientInvitation operation
type UpdateRecipientInvitationResponse struct {
// The underlying http response
RawResponse *http.Response
// The RecipientInvitation instance
RecipientInvitation `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateRecipientInvitationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateRecipientInvitationResponse) String() string
UpdateSenderInvitationDetails The parameters for updating a sender invitation.
type UpdateSenderInvitationDetails struct {
// A user-created name to describe the invitation. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// 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 UpdateSenderInvitationDetails) String() string
func (m UpdateSenderInvitationDetails) 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
UpdateSenderInvitationRequest wrapper for the UpdateSenderInvitation operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/UpdateSenderInvitation.go.html to see an example of how to use UpdateSenderInvitationRequest.
type UpdateSenderInvitationRequest struct {
// OCID of the sender invitation to update.
SenderInvitationId *string `mandatory:"true" contributesTo:"path" name:"senderInvitationId"`
// The information to be updated.
UpdateSenderInvitationDetails `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 UpdateSenderInvitationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateSenderInvitationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateSenderInvitationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateSenderInvitationRequest) String() string
func (request UpdateSenderInvitationRequest) 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
UpdateSenderInvitationResponse wrapper for the UpdateSenderInvitation operation
type UpdateSenderInvitationResponse struct {
// The underlying http response
RawResponse *http.Response
// The SenderInvitation instance
SenderInvitation `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateSenderInvitationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateSenderInvitationResponse) String() string
WorkRequest A description of the work request status.
type WorkRequest struct {
// Type of the work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of the current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The ID of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by the work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
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) 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 the status of the work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/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 Return a (paginated) list of errors for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/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 Return a (paginated) list of logs for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/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.
WorkRequestCollection Result of a query request for a list of work requests. Contains WorkRequestSummary items.
type WorkRequestCollection struct {
// Array containing WorkRequestSummary items.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
func (m WorkRequestCollection) String() string
func (m WorkRequestCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestError An error encountered while executing a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occured. Error codes are listed in
// API Errors (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm).
Code *string `mandatory:"true" json:"code"`
// A human-readable description of the issue encountered.
Message *string `mandatory:"true" json:"message"`
// The time the error occured. An RFC 3339 formatted date and time 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 Result of a query request for a list of work request errors. Contains WorkRequestError items.
type WorkRequestErrorCollection struct {
// Array containing WorkRequestError items.
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 RFC 3339 formatted date and time 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 Result of a query request for a list of work request log entries. Contains WorkRequestLogEntry items.
type WorkRequestLogEntryCollection struct {
// Array containing WorkRequestLogEntry items.
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"`
// Indicates how the 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 so that the user can do a GET to access the resource metadata.
EntityUri *string `mandatory:"false" json:"entityUri"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestSummary A summary of work request status.
type WorkRequestSummary struct {
// Type of the work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of the current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The ID of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by the work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
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