tenantmanagercontrolplane

package
v65.69.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 2, 2024 License: Apache-2.0, UPL-1.0 Imports: 7 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetActionTypeEnumStringValues 

func GetActionTypeEnumStringValues() []string

GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum

func GetAssignedSubscriptionEntityVersionEnumStringValues added in v65.45.0 

func GetAssignedSubscriptionEntityVersionEnumStringValues() []string

GetAssignedSubscriptionEntityVersionEnumStringValues Enumerates the set of values in String for AssignedSubscriptionEntityVersionEnum

func GetAssignedSubscriptionSummaryEntityVersionEnumStringValues added in v65.45.0 

func GetAssignedSubscriptionSummaryEntityVersionEnumStringValues() []string

GetAssignedSubscriptionSummaryEntityVersionEnumStringValues Enumerates the set of values in String for AssignedSubscriptionSummaryEntityVersionEnum

func GetBillingModelEnumStringValues added in v65.45.0 

func GetBillingModelEnumStringValues() []string

GetBillingModelEnumStringValues Enumerates the set of values in String for BillingModelEnum

func GetClassicSubscriptionEnvironmentNameEnumStringValues added in v65.45.0 

func GetClassicSubscriptionEnvironmentNameEnumStringValues() []string

GetClassicSubscriptionEnvironmentNameEnumStringValues Enumerates the set of values in String for ClassicSubscriptionEnvironmentNameEnum

func GetClassicSubscriptionLifecycleStateEnumStringValues added in v65.45.0 

func GetClassicSubscriptionLifecycleStateEnumStringValues() []string

GetClassicSubscriptionLifecycleStateEnumStringValues Enumerates the set of values in String for ClassicSubscriptionLifecycleStateEnum

func GetDomainGovernanceLifecycleStateEnumStringValues 

func GetDomainGovernanceLifecycleStateEnumStringValues() []string

GetDomainGovernanceLifecycleStateEnumStringValues Enumerates the set of values in String for DomainGovernanceLifecycleStateEnum

func GetDomainLifecycleStateEnumStringValues 

func GetDomainLifecycleStateEnumStringValues() []string

GetDomainLifecycleStateEnumStringValues Enumerates the set of values in String for DomainLifecycleStateEnum

func GetDomainStatusEnumStringValues 

func GetDomainStatusEnumStringValues() []string

GetDomainStatusEnumStringValues Enumerates the set of values in String for DomainStatusEnum

func GetEntityVersionEnumStringValues added in v65.45.0 

func GetEntityVersionEnumStringValues() []string

GetEntityVersionEnumStringValues Enumerates the set of values in String for EntityVersionEnum

func GetGovernanceStatusEnumStringValues added in v65.36.1 

func GetGovernanceStatusEnumStringValues() []string

GetGovernanceStatusEnumStringValues Enumerates the set of values in String for GovernanceStatusEnum

func GetInvitationSubjectEnumStringValues added in v65.36.1 

func GetInvitationSubjectEnumStringValues() []string

GetInvitationSubjectEnumStringValues Enumerates the set of values in String for InvitationSubjectEnum

func GetLifecycleStateEnumStringValues 

func GetLifecycleStateEnumStringValues() []string

GetLifecycleStateEnumStringValues Enumerates the set of values in String for LifecycleStateEnum

func GetListAssignedSubscriptionLineItemsSortByEnumStringValues added in v65.45.0 

func GetListAssignedSubscriptionLineItemsSortByEnumStringValues() []string

GetListAssignedSubscriptionLineItemsSortByEnumStringValues Enumerates the set of values in String for ListAssignedSubscriptionLineItemsSortByEnum

func GetListAssignedSubscriptionLineItemsSortOrderEnumStringValues added in v65.45.0 

func GetListAssignedSubscriptionLineItemsSortOrderEnumStringValues() []string

GetListAssignedSubscriptionLineItemsSortOrderEnumStringValues Enumerates the set of values in String for ListAssignedSubscriptionLineItemsSortOrderEnum

func GetListAssignedSubscriptionsEntityVersionEnumStringValues added in v65.45.0 

func GetListAssignedSubscriptionsEntityVersionEnumStringValues() []string

GetListAssignedSubscriptionsEntityVersionEnumStringValues Enumerates the set of values in String for ListAssignedSubscriptionsEntityVersionEnum

func GetListAssignedSubscriptionsSortByEnumStringValues 

func GetListAssignedSubscriptionsSortByEnumStringValues() []string

GetListAssignedSubscriptionsSortByEnumStringValues Enumerates the set of values in String for ListAssignedSubscriptionsSortByEnum

func GetListAssignedSubscriptionsSortOrderEnumStringValues 

func GetListAssignedSubscriptionsSortOrderEnumStringValues() []string

GetListAssignedSubscriptionsSortOrderEnumStringValues Enumerates the set of values in String for ListAssignedSubscriptionsSortOrderEnum

func GetListDomainGovernancesLifecycleStateEnumStringValues 

func GetListDomainGovernancesLifecycleStateEnumStringValues() []string

GetListDomainGovernancesLifecycleStateEnumStringValues Enumerates the set of values in String for ListDomainGovernancesLifecycleStateEnum

func GetListDomainGovernancesSortByEnumStringValues 

func GetListDomainGovernancesSortByEnumStringValues() []string

GetListDomainGovernancesSortByEnumStringValues Enumerates the set of values in String for ListDomainGovernancesSortByEnum

func GetListDomainGovernancesSortOrderEnumStringValues 

func GetListDomainGovernancesSortOrderEnumStringValues() []string

GetListDomainGovernancesSortOrderEnumStringValues Enumerates the set of values in String for ListDomainGovernancesSortOrderEnum

func GetListDomainsLifecycleStateEnumStringValues 

func GetListDomainsLifecycleStateEnumStringValues() []string

GetListDomainsLifecycleStateEnumStringValues Enumerates the set of values in String for ListDomainsLifecycleStateEnum

func GetListDomainsSortByEnumStringValues 

func GetListDomainsSortByEnumStringValues() []string

GetListDomainsSortByEnumStringValues Enumerates the set of values in String for ListDomainsSortByEnum

func GetListDomainsSortOrderEnumStringValues 

func GetListDomainsSortOrderEnumStringValues() []string

GetListDomainsSortOrderEnumStringValues Enumerates the set of values in String for ListDomainsSortOrderEnum

func GetListLinksLifecycleStateEnumStringValues 

func GetListLinksLifecycleStateEnumStringValues() []string

GetListLinksLifecycleStateEnumStringValues Enumerates the set of values in String for ListLinksLifecycleStateEnum

func GetListLinksSortOrderEnumStringValues 

func GetListLinksSortOrderEnumStringValues() []string

GetListLinksSortOrderEnumStringValues Enumerates the set of values in String for ListLinksSortOrderEnum

func GetListRecipientInvitationsLifecycleStateEnumStringValues 

func GetListRecipientInvitationsLifecycleStateEnumStringValues() []string

GetListRecipientInvitationsLifecycleStateEnumStringValues Enumerates the set of values in String for ListRecipientInvitationsLifecycleStateEnum

func GetListRecipientInvitationsStatusEnumStringValues 

func GetListRecipientInvitationsStatusEnumStringValues() []string

GetListRecipientInvitationsStatusEnumStringValues Enumerates the set of values in String for ListRecipientInvitationsStatusEnum

func GetListSenderInvitationsLifecycleStateEnumStringValues 

func GetListSenderInvitationsLifecycleStateEnumStringValues() []string

GetListSenderInvitationsLifecycleStateEnumStringValues Enumerates the set of values in String for ListSenderInvitationsLifecycleStateEnum

func GetListSenderInvitationsSortByEnumStringValues 

func GetListSenderInvitationsSortByEnumStringValues() []string

GetListSenderInvitationsSortByEnumStringValues Enumerates the set of values in String for ListSenderInvitationsSortByEnum

func GetListSenderInvitationsSortOrderEnumStringValues 

func GetListSenderInvitationsSortOrderEnumStringValues() []string

GetListSenderInvitationsSortOrderEnumStringValues Enumerates the set of values in String for ListSenderInvitationsSortOrderEnum

func GetListSenderInvitationsStatusEnumStringValues 

func GetListSenderInvitationsStatusEnumStringValues() []string

GetListSenderInvitationsStatusEnumStringValues Enumerates the set of values in String for ListSenderInvitationsStatusEnum

func GetListSubscriptionLineItemsSortByEnumStringValues added in v65.45.0 

func GetListSubscriptionLineItemsSortByEnumStringValues() []string

GetListSubscriptionLineItemsSortByEnumStringValues Enumerates the set of values in String for ListSubscriptionLineItemsSortByEnum

func GetListSubscriptionLineItemsSortOrderEnumStringValues added in v65.45.0 

func GetListSubscriptionLineItemsSortOrderEnumStringValues() []string

GetListSubscriptionLineItemsSortOrderEnumStringValues Enumerates the set of values in String for ListSubscriptionLineItemsSortOrderEnum

func GetListSubscriptionMappingsSortByEnumStringValues 

func GetListSubscriptionMappingsSortByEnumStringValues() []string

GetListSubscriptionMappingsSortByEnumStringValues Enumerates the set of values in String for ListSubscriptionMappingsSortByEnum

func GetListSubscriptionMappingsSortOrderEnumStringValues 

func GetListSubscriptionMappingsSortOrderEnumStringValues() []string

GetListSubscriptionMappingsSortOrderEnumStringValues Enumerates the set of values in String for ListSubscriptionMappingsSortOrderEnum

func GetListSubscriptionsEntityVersionEnumStringValues added in v65.45.0 

func GetListSubscriptionsEntityVersionEnumStringValues() []string

GetListSubscriptionsEntityVersionEnumStringValues Enumerates the set of values in String for ListSubscriptionsEntityVersionEnum

func GetListSubscriptionsSortByEnumStringValues 

func GetListSubscriptionsSortByEnumStringValues() []string

GetListSubscriptionsSortByEnumStringValues Enumerates the set of values in String for ListSubscriptionsSortByEnum

func GetListSubscriptionsSortOrderEnumStringValues 

func GetListSubscriptionsSortOrderEnumStringValues() []string

GetListSubscriptionsSortOrderEnumStringValues Enumerates the set of values in String for ListSubscriptionsSortOrderEnum

func GetListWorkRequestErrorsSortOrderEnumStringValues 

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string

GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestLogsSortOrderEnumStringValues 

func GetListWorkRequestLogsSortOrderEnumStringValues() []string

GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestsSortOrderEnumStringValues 

func GetListWorkRequestsSortOrderEnumStringValues() []string

GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum

func GetOperationStatusEnumStringValues 

func GetOperationStatusEnumStringValues() []string

GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum

func GetOperationTypeEnumStringValues 

func GetOperationTypeEnumStringValues() []string

GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum

func GetOrganizationLifecycleStateEnumStringValues 

func GetOrganizationLifecycleStateEnumStringValues() []string

GetOrganizationLifecycleStateEnumStringValues Enumerates the set of values in String for OrganizationLifecycleStateEnum

func GetOrganizationTenancyLifecycleStateEnumStringValues 

func GetOrganizationTenancyLifecycleStateEnumStringValues() []string

GetOrganizationTenancyLifecycleStateEnumStringValues Enumerates the set of values in String for OrganizationTenancyLifecycleStateEnum

func GetOrganizationTenancyRoleEnumStringValues 

func GetOrganizationTenancyRoleEnumStringValues() []string

GetOrganizationTenancyRoleEnumStringValues Enumerates the set of values in String for OrganizationTenancyRoleEnum

func GetPromotionStatusEnumStringValues added in v65.11.0 

func GetPromotionStatusEnumStringValues() []string

GetPromotionStatusEnumStringValues Enumerates the set of values in String for PromotionStatusEnum

func GetRecipientInvitationStatusEnumStringValues 

func GetRecipientInvitationStatusEnumStringValues() []string

GetRecipientInvitationStatusEnumStringValues Enumerates the set of values in String for RecipientInvitationStatusEnum

func GetSenderInvitationStatusEnumStringValues 

func GetSenderInvitationStatusEnumStringValues() []string

GetSenderInvitationStatusEnumStringValues Enumerates the set of values in String for SenderInvitationStatusEnum

func GetSortOrderEnumStringValues 

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

func GetSubscriptionEntityVersionEnumStringValues added in v65.45.0 

func GetSubscriptionEntityVersionEnumStringValues() []string

GetSubscriptionEntityVersionEnumStringValues Enumerates the set of values in String for SubscriptionEntityVersionEnum

func GetSubscriptionLifecycleStateEnumStringValues 

func GetSubscriptionLifecycleStateEnumStringValues() []string

GetSubscriptionLifecycleStateEnumStringValues Enumerates the set of values in String for SubscriptionLifecycleStateEnum

func GetSubscriptionMappingLifecycleStateEnumStringValues 

func GetSubscriptionMappingLifecycleStateEnumStringValues() []string

GetSubscriptionMappingLifecycleStateEnumStringValues Enumerates the set of values in String for SubscriptionMappingLifecycleStateEnum

func GetSubscriptionSummaryEntityVersionEnumStringValues added in v65.45.0 

func GetSubscriptionSummaryEntityVersionEnumStringValues() []string

GetSubscriptionSummaryEntityVersionEnumStringValues Enumerates the set of values in String for SubscriptionSummaryEntityVersionEnum

Types

type 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
}

AcceptRecipientInvitationRequest wrapper for the AcceptRecipientInvitation operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/AcceptRecipientInvitation.go.html to see an example of how to use AcceptRecipientInvitationRequest.

func (AcceptRecipientInvitationRequest) BinaryRequestBody 

func (request AcceptRecipientInvitationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (AcceptRecipientInvitationRequest) HTTPRequest 

func (request AcceptRecipientInvitationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (AcceptRecipientInvitationRequest) RetryPolicy 

func (request AcceptRecipientInvitationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (AcceptRecipientInvitationRequest) String 

func (request AcceptRecipientInvitationRequest) String() string

func (AcceptRecipientInvitationRequest) ValidateEnumValue 

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

type AcceptRecipientInvitationResponse 

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"`
}

AcceptRecipientInvitationResponse wrapper for the AcceptRecipientInvitation operation

func (AcceptRecipientInvitationResponse) HTTPResponse 

func (response AcceptRecipientInvitationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (AcceptRecipientInvitationResponse) String 

func (response AcceptRecipientInvitationResponse) String() string

type ActionTypeEnum 

type ActionTypeEnum string

ActionTypeEnum Enum with underlying type: string 

const (
	ActionTypeCreated    ActionTypeEnum = "CREATED"
	ActionTypeUpdated    ActionTypeEnum = "UPDATED"
	ActionTypeDeleted    ActionTypeEnum = "DELETED"
	ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
	ActionTypeRelated    ActionTypeEnum = "RELATED"
)

Set of constants representing the allowable values for ActionTypeEnum

func GetActionTypeEnumValues 

func GetActionTypeEnumValues() []ActionTypeEnum

GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum

func GetMappingActionTypeEnum 

func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)

GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type ActivateOrderDetails 

type ActivateOrderDetails struct {

	// Tenant ID to activate the order.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ActivateOrderDetails The parameters for activating an order subscription in a tenancy.

func (ActivateOrderDetails) String 

func (m ActivateOrderDetails) String() string

func (ActivateOrderDetails) ValidateEnumValue 

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

type 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
}

ActivateOrderRequest wrapper for the ActivateOrder operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ActivateOrder.go.html to see an example of how to use ActivateOrderRequest.

func (ActivateOrderRequest) BinaryRequestBody 

func (request ActivateOrderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ActivateOrderRequest) HTTPRequest 

func (request ActivateOrderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ActivateOrderRequest) RetryPolicy 

func (request ActivateOrderRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ActivateOrderRequest) String 

func (request ActivateOrderRequest) String() string

func (ActivateOrderRequest) ValidateEnumValue 

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

type ActivateOrderResponse 

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"`
}

ActivateOrderResponse wrapper for the ActivateOrder operation

func (ActivateOrderResponse) HTTPResponse 

func (response ActivateOrderResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ActivateOrderResponse) String 

func (response ActivateOrderResponse) String() string

type AddGovernanceRequest added in v65.36.1 

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
}

AddGovernanceRequest wrapper for the AddGovernance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/AddGovernance.go.html to see an example of how to use AddGovernanceRequest.

func (AddGovernanceRequest) BinaryRequestBody added in v65.36.1 

func (request AddGovernanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (AddGovernanceRequest) HTTPRequest added in v65.36.1 

func (request AddGovernanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (AddGovernanceRequest) RetryPolicy added in v65.36.1 

func (request AddGovernanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (AddGovernanceRequest) String added in v65.36.1 

func (request AddGovernanceRequest) String() string

func (AddGovernanceRequest) ValidateEnumValue added in v65.36.1 

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

type AddGovernanceResponse added in v65.36.1 

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"`
}

AddGovernanceResponse wrapper for the AddGovernance operation

func (AddGovernanceResponse) HTTPResponse added in v65.36.1 

func (response AddGovernanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (AddGovernanceResponse) String added in v65.36.1 

func (response AddGovernanceResponse) String() string

type 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
}

ApproveOrganizationTenancyForTransferRequest wrapper for the ApproveOrganizationTenancyForTransfer operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ApproveOrganizationTenancyForTransfer.go.html to see an example of how to use ApproveOrganizationTenancyForTransferRequest.

func (ApproveOrganizationTenancyForTransferRequest) BinaryRequestBody 

func (request ApproveOrganizationTenancyForTransferRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ApproveOrganizationTenancyForTransferRequest) HTTPRequest 

func (request ApproveOrganizationTenancyForTransferRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ApproveOrganizationTenancyForTransferRequest) RetryPolicy 

func (request ApproveOrganizationTenancyForTransferRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ApproveOrganizationTenancyForTransferRequest) String 

func (request ApproveOrganizationTenancyForTransferRequest) String() string

func (ApproveOrganizationTenancyForTransferRequest) ValidateEnumValue 

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

type ApproveOrganizationTenancyForTransferResponse 

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"`
}

ApproveOrganizationTenancyForTransferResponse wrapper for the ApproveOrganizationTenancyForTransfer operation

func (ApproveOrganizationTenancyForTransferResponse) HTTPResponse 

func (response ApproveOrganizationTenancyForTransferResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ApproveOrganizationTenancyForTransferResponse) String 

func (response ApproveOrganizationTenancyForTransferResponse) String() string

type AssignedSubscription 

type AssignedSubscription interface {

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the subscription.
	GetId() *string

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/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{}
}

AssignedSubscription Assigned subscription type, which carries shared properties for any assigned subscription version.

type AssignedSubscriptionCollection 

type AssignedSubscriptionCollection struct {

	// Array containing assigned subscription summary items.
	Items []AssignedSubscriptionSummary `mandatory:"true" json:"items"`
}

AssignedSubscriptionCollection Collection of assigned subscription summaries.

func (AssignedSubscriptionCollection) String 

func (m AssignedSubscriptionCollection) String() string

func (*AssignedSubscriptionCollection) UnmarshalJSON added in v65.45.0 

func (m *AssignedSubscriptionCollection) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (AssignedSubscriptionCollection) ValidateEnumValue 

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

type AssignedSubscriptionEntityVersionEnum added in v65.45.0 

type AssignedSubscriptionEntityVersionEnum string

AssignedSubscriptionEntityVersionEnum Enum with underlying type: string 

const (
	AssignedSubscriptionEntityVersionV1 AssignedSubscriptionEntityVersionEnum = "V1"
	AssignedSubscriptionEntityVersionV2 AssignedSubscriptionEntityVersionEnum = "V2"
)

Set of constants representing the allowable values for AssignedSubscriptionEntityVersionEnum

func GetAssignedSubscriptionEntityVersionEnumValues added in v65.45.0 

func GetAssignedSubscriptionEntityVersionEnumValues() []AssignedSubscriptionEntityVersionEnum

GetAssignedSubscriptionEntityVersionEnumValues Enumerates the set of values for AssignedSubscriptionEntityVersionEnum

func GetMappingAssignedSubscriptionEntityVersionEnum added in v65.45.0 

func GetMappingAssignedSubscriptionEntityVersionEnum(val string) (AssignedSubscriptionEntityVersionEnum, bool)

GetMappingAssignedSubscriptionEntityVersionEnum performs case Insensitive comparison on enum value and return the desired enum

type AssignedSubscriptionLineItemCollection added in v65.45.0 

type AssignedSubscriptionLineItemCollection struct {

	// Array containing line item summaries in an assigned subscription.
	Items []AssignedSubscriptionLineItemSummary `mandatory:"true" json:"items"`
}

AssignedSubscriptionLineItemCollection Collection of line item summaries in an assigned subscription.

func (AssignedSubscriptionLineItemCollection) String added in v65.45.0 

func (m AssignedSubscriptionLineItemCollection) String() string

func (AssignedSubscriptionLineItemCollection) ValidateEnumValue added in v65.45.0 

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

type AssignedSubscriptionLineItemSummary added in v65.45.0 

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"`
}

AssignedSubscriptionLineItemSummary Summary of the line item in an assigned subscription.

func (AssignedSubscriptionLineItemSummary) String added in v65.45.0 

func (m AssignedSubscriptionLineItemSummary) String() string

func (AssignedSubscriptionLineItemSummary) ValidateEnumValue added in v65.45.0 

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

type AssignedSubscriptionSummary 

type AssignedSubscriptionSummary interface {

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the subscription.
	GetId() *string

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/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{}
}

AssignedSubscriptionSummary Assigned subscription summary type, which carries shared properties for any assigned subscription summary version.

type AssignedSubscriptionSummaryEntityVersionEnum added in v65.45.0 

type AssignedSubscriptionSummaryEntityVersionEnum string

AssignedSubscriptionSummaryEntityVersionEnum Enum with underlying type: string 

const (
	AssignedSubscriptionSummaryEntityVersionV1 AssignedSubscriptionSummaryEntityVersionEnum = "V1"
	AssignedSubscriptionSummaryEntityVersionV2 AssignedSubscriptionSummaryEntityVersionEnum = "V2"
)

Set of constants representing the allowable values for AssignedSubscriptionSummaryEntityVersionEnum

func GetAssignedSubscriptionSummaryEntityVersionEnumValues added in v65.45.0 

func GetAssignedSubscriptionSummaryEntityVersionEnumValues() []AssignedSubscriptionSummaryEntityVersionEnum

GetAssignedSubscriptionSummaryEntityVersionEnumValues Enumerates the set of values for AssignedSubscriptionSummaryEntityVersionEnum

func GetMappingAssignedSubscriptionSummaryEntityVersionEnum added in v65.45.0 

func GetMappingAssignedSubscriptionSummaryEntityVersionEnum(val string) (AssignedSubscriptionSummaryEntityVersionEnum, bool)

GetMappingAssignedSubscriptionSummaryEntityVersionEnum performs case Insensitive comparison on enum value and return the desired enum

type AvailableRegionCollection 

type AvailableRegionCollection struct {

	// Array containing available region items.
	Items []AvailableRegionSummary `mandatory:"true" json:"items"`
}

AvailableRegionCollection List of available regions.

func (AvailableRegionCollection) String 

func (m AvailableRegionCollection) String() string

func (AvailableRegionCollection) ValidateEnumValue 

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

type AvailableRegionSummary 

type AvailableRegionSummary struct {

	// Region availability for the subscription.
	RegionName *string `mandatory:"true" json:"regionName"`
}

AvailableRegionSummary The summary of region availability for a subscription.

func (AvailableRegionSummary) String 

func (m AvailableRegionSummary) String() string

func (AvailableRegionSummary) ValidateEnumValue 

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

type BillingModelEnum added in v65.45.0 

type BillingModelEnum string

BillingModelEnum Enum with underlying type: string 

const (
	BillingModelCommitment BillingModelEnum = "COMMITMENT"
	BillingModelPaygo      BillingModelEnum = "PAYGO"
	BillingModelPromotion  BillingModelEnum = "PROMOTION"
)

Set of constants representing the allowable values for BillingModelEnum

func GetBillingModelEnumValues added in v65.45.0 

func GetBillingModelEnumValues() []BillingModelEnum

GetBillingModelEnumValues Enumerates the set of values for BillingModelEnum

func GetMappingBillingModelEnum added in v65.45.0 

func GetMappingBillingModelEnum(val string) (BillingModelEnum, bool)

GetMappingBillingModelEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

CancelSenderInvitationRequest wrapper for the CancelSenderInvitation operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/CancelSenderInvitation.go.html to see an example of how to use CancelSenderInvitationRequest.

func (CancelSenderInvitationRequest) BinaryRequestBody 

func (request CancelSenderInvitationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CancelSenderInvitationRequest) HTTPRequest 

func (request CancelSenderInvitationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CancelSenderInvitationRequest) RetryPolicy 

func (request CancelSenderInvitationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CancelSenderInvitationRequest) String 

func (request CancelSenderInvitationRequest) String() string

func (CancelSenderInvitationRequest) ValidateEnumValue 

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

type CancelSenderInvitationResponse 

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"`
}

CancelSenderInvitationResponse wrapper for the CancelSenderInvitation operation

func (CancelSenderInvitationResponse) HTTPResponse 

func (response CancelSenderInvitationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CancelSenderInvitationResponse) String 

func (response CancelSenderInvitationResponse) String() string

type ClassicAssignedSubscription added in v65.45.0 

type ClassicAssignedSubscription struct {

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the subscription.
	Id *string `mandatory:"true" json:"id"`

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/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"`
}

ClassicAssignedSubscription Assigned subscription information.

func (ClassicAssignedSubscription) GetCompartmentId added in v65.45.0 

func (m ClassicAssignedSubscription) GetCompartmentId() *string

GetCompartmentId returns CompartmentId

func (ClassicAssignedSubscription) GetDefinedTags added in v65.45.0 

func (m ClassicAssignedSubscription) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (ClassicAssignedSubscription) GetFreeformTags added in v65.45.0 

func (m ClassicAssignedSubscription) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (ClassicAssignedSubscription) GetId added in v65.45.0 

func (m ClassicAssignedSubscription) GetId() *string

GetId returns Id

func (ClassicAssignedSubscription) GetServiceName added in v65.45.0 

func (m ClassicAssignedSubscription) GetServiceName() *string

GetServiceName returns ServiceName

func (ClassicAssignedSubscription) GetTimeCreated added in v65.45.0 

func (m ClassicAssignedSubscription) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (ClassicAssignedSubscription) GetTimeUpdated added in v65.45.0 

func (m ClassicAssignedSubscription) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (ClassicAssignedSubscription) MarshalJSON added in v65.45.0 

func (m ClassicAssignedSubscription) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ClassicAssignedSubscription) String added in v65.45.0 

func (m ClassicAssignedSubscription) String() string

func (ClassicAssignedSubscription) ValidateEnumValue added in v65.45.0 

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

type ClassicAssignedSubscriptionSummary added in v65.45.0 

type ClassicAssignedSubscriptionSummary struct {

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the subscription.
	Id *string `mandatory:"true" json:"id"`

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/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"`

	// 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"`
}

ClassicAssignedSubscriptionSummary Summary of assigned subscription information.

func (ClassicAssignedSubscriptionSummary) GetCompartmentId added in v65.45.0 

func (m ClassicAssignedSubscriptionSummary) GetCompartmentId() *string

GetCompartmentId returns CompartmentId

func (ClassicAssignedSubscriptionSummary) GetDefinedTags added in v65.45.0 

func (m ClassicAssignedSubscriptionSummary) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (ClassicAssignedSubscriptionSummary) GetFreeformTags added in v65.45.0 

func (m ClassicAssignedSubscriptionSummary) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (ClassicAssignedSubscriptionSummary) GetId added in v65.45.0 

func (m ClassicAssignedSubscriptionSummary) GetId() *string

GetId returns Id

func (ClassicAssignedSubscriptionSummary) GetServiceName added in v65.45.0 

func (m ClassicAssignedSubscriptionSummary) GetServiceName() *string

GetServiceName returns ServiceName

func (ClassicAssignedSubscriptionSummary) GetTimeCreated added in v65.45.0 

func (m ClassicAssignedSubscriptionSummary) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (ClassicAssignedSubscriptionSummary) GetTimeUpdated added in v65.45.0 

func (m ClassicAssignedSubscriptionSummary) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (ClassicAssignedSubscriptionSummary) MarshalJSON added in v65.45.0 

func (m ClassicAssignedSubscriptionSummary) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ClassicAssignedSubscriptionSummary) String added in v65.45.0 

func (m ClassicAssignedSubscriptionSummary) String() string

func (ClassicAssignedSubscriptionSummary) ValidateEnumValue added in v65.45.0 

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

type ClassicSubscription added in v65.45.0 

type ClassicSubscription struct {

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the subscription.
	Id *string `mandatory:"true" json:"id"`

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/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"`

	// Lifecycle state of the subscription.
	LifecycleState ClassicSubscriptionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}

ClassicSubscription Subscription information for the compartmentId. Only root compartments are allowed.

func (ClassicSubscription) GetCompartmentId added in v65.45.0 

func (m ClassicSubscription) GetCompartmentId() *string

GetCompartmentId returns CompartmentId

func (ClassicSubscription) GetDefinedTags added in v65.45.0 

func (m ClassicSubscription) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (ClassicSubscription) GetFreeformTags added in v65.45.0 

func (m ClassicSubscription) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (ClassicSubscription) GetId added in v65.45.0 

func (m ClassicSubscription) GetId() *string

GetId returns Id

func (ClassicSubscription) GetServiceName added in v65.45.0 

func (m ClassicSubscription) GetServiceName() *string

GetServiceName returns ServiceName

func (ClassicSubscription) GetTimeCreated added in v65.45.0 

func (m ClassicSubscription) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (ClassicSubscription) GetTimeUpdated added in v65.45.0 

func (m ClassicSubscription) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (ClassicSubscription) MarshalJSON added in v65.45.0 

func (m ClassicSubscription) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ClassicSubscription) String added in v65.45.0 

func (m ClassicSubscription) String() string

func (ClassicSubscription) ValidateEnumValue added in v65.45.0 

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

type ClassicSubscriptionEnvironmentNameEnum added in v65.45.0 

type ClassicSubscriptionEnvironmentNameEnum string

ClassicSubscriptionEnvironmentNameEnum Enum with underlying type: string 

const (
	ClassicSubscriptionEnvironmentNameProd     ClassicSubscriptionEnvironmentNameEnum = "PROD"
	ClassicSubscriptionEnvironmentNamePreprod  ClassicSubscriptionEnvironmentNameEnum = "PREPROD"
	ClassicSubscriptionEnvironmentNamePreprod1 ClassicSubscriptionEnvironmentNameEnum = "PREPROD1"
	ClassicSubscriptionEnvironmentNamePintlab  ClassicSubscriptionEnvironmentNameEnum = "PINTLAB"
	ClassicSubscriptionEnvironmentNameMiglab   ClassicSubscriptionEnvironmentNameEnum = "MIGLAB"
	ClassicSubscriptionEnvironmentNamePool2    ClassicSubscriptionEnvironmentNameEnum = "POOL2"
	ClassicSubscriptionEnvironmentNamePintlab2 ClassicSubscriptionEnvironmentNameEnum = "PINTLAB2"
	ClassicSubscriptionEnvironmentNameMylab0   ClassicSubscriptionEnvironmentNameEnum = "MYLAB0"
	ClassicSubscriptionEnvironmentNameMylab1   ClassicSubscriptionEnvironmentNameEnum = "MYLAB1"
	ClassicSubscriptionEnvironmentNameMylab2   ClassicSubscriptionEnvironmentNameEnum = "MYLAB2"
	ClassicSubscriptionEnvironmentNameMylab3   ClassicSubscriptionEnvironmentNameEnum = "MYLAB3"
	ClassicSubscriptionEnvironmentNameMylab4   ClassicSubscriptionEnvironmentNameEnum = "MYLAB4"
	ClassicSubscriptionEnvironmentNameMylab5   ClassicSubscriptionEnvironmentNameEnum = "MYLAB5"
)

Set of constants representing the allowable values for ClassicSubscriptionEnvironmentNameEnum

func GetClassicSubscriptionEnvironmentNameEnumValues added in v65.45.0 

func GetClassicSubscriptionEnvironmentNameEnumValues() []ClassicSubscriptionEnvironmentNameEnum

GetClassicSubscriptionEnvironmentNameEnumValues Enumerates the set of values for ClassicSubscriptionEnvironmentNameEnum

func GetMappingClassicSubscriptionEnvironmentNameEnum added in v65.45.0 

func GetMappingClassicSubscriptionEnvironmentNameEnum(val string) (ClassicSubscriptionEnvironmentNameEnum, bool)

GetMappingClassicSubscriptionEnvironmentNameEnum performs case Insensitive comparison on enum value and return the desired enum

type ClassicSubscriptionLifecycleStateEnum added in v65.45.0 

type ClassicSubscriptionLifecycleStateEnum string

ClassicSubscriptionLifecycleStateEnum Enum with underlying type: string 

const (
	ClassicSubscriptionLifecycleStateCreating ClassicSubscriptionLifecycleStateEnum = "CREATING"
	ClassicSubscriptionLifecycleStateActive   ClassicSubscriptionLifecycleStateEnum = "ACTIVE"
	ClassicSubscriptionLifecycleStateInactive ClassicSubscriptionLifecycleStateEnum = "INACTIVE"
	ClassicSubscriptionLifecycleStateUpdating ClassicSubscriptionLifecycleStateEnum = "UPDATING"
	ClassicSubscriptionLifecycleStateDeleting ClassicSubscriptionLifecycleStateEnum = "DELETING"
	ClassicSubscriptionLifecycleStateDeleted  ClassicSubscriptionLifecycleStateEnum = "DELETED"
	ClassicSubscriptionLifecycleStateFailed   ClassicSubscriptionLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for ClassicSubscriptionLifecycleStateEnum

func GetClassicSubscriptionLifecycleStateEnumValues added in v65.45.0 

func GetClassicSubscriptionLifecycleStateEnumValues() []ClassicSubscriptionLifecycleStateEnum

GetClassicSubscriptionLifecycleStateEnumValues Enumerates the set of values for ClassicSubscriptionLifecycleStateEnum

func GetMappingClassicSubscriptionLifecycleStateEnum added in v65.45.0 

func GetMappingClassicSubscriptionLifecycleStateEnum(val string) (ClassicSubscriptionLifecycleStateEnum, bool)

GetMappingClassicSubscriptionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type ClassicSubscriptionSummary added in v65.45.0 

type ClassicSubscriptionSummary struct {

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the subscription.
	Id *string `mandatory:"true" json:"id"`

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/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"`

	// 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"`
}

ClassicSubscriptionSummary Summary of subscription.

func (ClassicSubscriptionSummary) GetCompartmentId added in v65.45.0 

func (m ClassicSubscriptionSummary) GetCompartmentId() *string

GetCompartmentId returns CompartmentId

func (ClassicSubscriptionSummary) GetDefinedTags added in v65.45.0 

func (m ClassicSubscriptionSummary) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (ClassicSubscriptionSummary) GetFreeformTags added in v65.45.0 

func (m ClassicSubscriptionSummary) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (ClassicSubscriptionSummary) GetId added in v65.45.0 

func (m ClassicSubscriptionSummary) GetId() *string

GetId returns Id

func (ClassicSubscriptionSummary) GetServiceName added in v65.45.0 

func (m ClassicSubscriptionSummary) GetServiceName() *string

GetServiceName returns ServiceName

func (ClassicSubscriptionSummary) GetTimeCreated added in v65.45.0 

func (m ClassicSubscriptionSummary) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (ClassicSubscriptionSummary) GetTimeUpdated added in v65.45.0 

func (m ClassicSubscriptionSummary) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (ClassicSubscriptionSummary) MarshalJSON added in v65.45.0 

func (m ClassicSubscriptionSummary) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ClassicSubscriptionSummary) String added in v65.45.0 

func (m ClassicSubscriptionSummary) String() string

func (ClassicSubscriptionSummary) ValidateEnumValue added in v65.45.0 

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

type CloudAssignedSubscription added in v65.45.0 

type CloudAssignedSubscription struct {

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the subscription.
	Id *string `mandatory:"true" json:"id"`

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/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"`
}

CloudAssignedSubscription Assigned subscription information.

func (CloudAssignedSubscription) GetCompartmentId added in v65.45.0 

func (m CloudAssignedSubscription) GetCompartmentId() *string

GetCompartmentId returns CompartmentId

func (CloudAssignedSubscription) GetDefinedTags added in v65.45.0 

func (m CloudAssignedSubscription) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CloudAssignedSubscription) GetFreeformTags added in v65.45.0 

func (m CloudAssignedSubscription) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CloudAssignedSubscription) GetId added in v65.45.0 

func (m CloudAssignedSubscription) GetId() *string

GetId returns Id

func (CloudAssignedSubscription) GetServiceName added in v65.45.0 

func (m CloudAssignedSubscription) GetServiceName() *string

GetServiceName returns ServiceName

func (CloudAssignedSubscription) GetTimeCreated added in v65.45.0 

func (m CloudAssignedSubscription) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (CloudAssignedSubscription) GetTimeUpdated added in v65.45.0 

func (m CloudAssignedSubscription) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (CloudAssignedSubscription) MarshalJSON added in v65.45.0 

func (m CloudAssignedSubscription) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CloudAssignedSubscription) String added in v65.45.0 

func (m CloudAssignedSubscription) String() string

func (CloudAssignedSubscription) ValidateEnumValue added in v65.45.0 

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

type CloudAssignedSubscriptionSummary added in v65.45.0 

type CloudAssignedSubscriptionSummary struct {

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the subscription.
	Id *string `mandatory:"true" json:"id"`

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/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"`
}

CloudAssignedSubscriptionSummary Summary of assigned subscription information.

func (CloudAssignedSubscriptionSummary) GetCompartmentId added in v65.45.0 

func (m CloudAssignedSubscriptionSummary) GetCompartmentId() *string

GetCompartmentId returns CompartmentId

func (CloudAssignedSubscriptionSummary) GetDefinedTags added in v65.45.0 

func (m CloudAssignedSubscriptionSummary) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CloudAssignedSubscriptionSummary) GetFreeformTags added in v65.45.0 

func (m CloudAssignedSubscriptionSummary) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CloudAssignedSubscriptionSummary) GetId added in v65.45.0 

func (m CloudAssignedSubscriptionSummary) GetId() *string

GetId returns Id

func (CloudAssignedSubscriptionSummary) GetServiceName added in v65.45.0 

func (m CloudAssignedSubscriptionSummary) GetServiceName() *string

GetServiceName returns ServiceName

func (CloudAssignedSubscriptionSummary) GetTimeCreated added in v65.45.0 

func (m CloudAssignedSubscriptionSummary) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (CloudAssignedSubscriptionSummary) GetTimeUpdated added in v65.45.0 

func (m CloudAssignedSubscriptionSummary) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (CloudAssignedSubscriptionSummary) MarshalJSON added in v65.45.0 

func (m CloudAssignedSubscriptionSummary) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CloudAssignedSubscriptionSummary) String added in v65.45.0 

func (m CloudAssignedSubscriptionSummary) String() string

func (CloudAssignedSubscriptionSummary) ValidateEnumValue added in v65.45.0 

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

type CloudSubscription added in v65.45.0 

type CloudSubscription struct {

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the subscription.
	Id *string `mandatory:"true" json:"id"`

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/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"`
}

CloudSubscription Subscription information for compartment ID. Only root compartments are allowed.

func (CloudSubscription) GetCompartmentId added in v65.45.0 

func (m CloudSubscription) GetCompartmentId() *string

GetCompartmentId returns CompartmentId

func (CloudSubscription) GetDefinedTags added in v65.45.0 

func (m CloudSubscription) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CloudSubscription) GetFreeformTags added in v65.45.0 

func (m CloudSubscription) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CloudSubscription) GetId added in v65.45.0 

func (m CloudSubscription) GetId() *string

GetId returns Id

func (CloudSubscription) GetServiceName added in v65.45.0 

func (m CloudSubscription) GetServiceName() *string

GetServiceName returns ServiceName

func (CloudSubscription) GetTimeCreated added in v65.45.0 

func (m CloudSubscription) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (CloudSubscription) GetTimeUpdated added in v65.45.0 

func (m CloudSubscription) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (CloudSubscription) MarshalJSON added in v65.45.0 

func (m CloudSubscription) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CloudSubscription) String added in v65.45.0 

func (m CloudSubscription) String() string

func (CloudSubscription) ValidateEnumValue added in v65.45.0 

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

type CloudSubscriptionSummary added in v65.45.0 

type CloudSubscriptionSummary struct {

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the subscription.
	Id *string `mandatory:"true" json:"id"`

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/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"`
}

CloudSubscriptionSummary Summary of subscription.

func (CloudSubscriptionSummary) GetCompartmentId added in v65.45.0 

func (m CloudSubscriptionSummary) GetCompartmentId() *string

GetCompartmentId returns CompartmentId

func (CloudSubscriptionSummary) GetDefinedTags added in v65.45.0 

func (m CloudSubscriptionSummary) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CloudSubscriptionSummary) GetFreeformTags added in v65.45.0 

func (m CloudSubscriptionSummary) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CloudSubscriptionSummary) GetId added in v65.45.0 

func (m CloudSubscriptionSummary) GetId() *string

GetId returns Id

func (CloudSubscriptionSummary) GetServiceName added in v65.45.0 

func (m CloudSubscriptionSummary) GetServiceName() *string

GetServiceName returns ServiceName

func (CloudSubscriptionSummary) GetTimeCreated added in v65.45.0 

func (m CloudSubscriptionSummary) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (CloudSubscriptionSummary) GetTimeUpdated added in v65.45.0 

func (m CloudSubscriptionSummary) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (CloudSubscriptionSummary) MarshalJSON added in v65.45.0 

func (m CloudSubscriptionSummary) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CloudSubscriptionSummary) String added in v65.45.0 

func (m CloudSubscriptionSummary) String() string

func (CloudSubscriptionSummary) ValidateEnumValue added in v65.45.0 

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

type CreateChildTenancyDetails 

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"`
}

CreateChildTenancyDetails The parameters for creating a child tenancy.

func (CreateChildTenancyDetails) String 

func (m CreateChildTenancyDetails) String() string

func (CreateChildTenancyDetails) ValidateEnumValue 

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

type 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
}

CreateChildTenancyRequest wrapper for the CreateChildTenancy operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/CreateChildTenancy.go.html to see an example of how to use CreateChildTenancyRequest.

func (CreateChildTenancyRequest) BinaryRequestBody 

func (request CreateChildTenancyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateChildTenancyRequest) HTTPRequest 

func (request CreateChildTenancyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateChildTenancyRequest) RetryPolicy 

func (request CreateChildTenancyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateChildTenancyRequest) String 

func (request CreateChildTenancyRequest) String() string

func (CreateChildTenancyRequest) ValidateEnumValue 

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

type CreateChildTenancyResponse 

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"`
}

CreateChildTenancyResponse wrapper for the CreateChildTenancy operation

func (CreateChildTenancyResponse) HTTPResponse 

func (response CreateChildTenancyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateChildTenancyResponse) String 

func (response CreateChildTenancyResponse) String() string

type CreateDomainDetails 

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"`
}

CreateDomainDetails The parameters for creating a domain.

func (CreateDomainDetails) String 

func (m CreateDomainDetails) String() string

func (CreateDomainDetails) ValidateEnumValue 

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

type CreateDomainGovernanceDetails 

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"`
}

CreateDomainGovernanceDetails The parameters for creating a domain governance entity.

func (CreateDomainGovernanceDetails) String 

func (m CreateDomainGovernanceDetails) String() string

func (CreateDomainGovernanceDetails) ValidateEnumValue 

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

type 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
}

CreateDomainGovernanceRequest wrapper for the CreateDomainGovernance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/CreateDomainGovernance.go.html to see an example of how to use CreateDomainGovernanceRequest.

func (CreateDomainGovernanceRequest) BinaryRequestBody 

func (request CreateDomainGovernanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateDomainGovernanceRequest) HTTPRequest 

func (request CreateDomainGovernanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateDomainGovernanceRequest) RetryPolicy 

func (request CreateDomainGovernanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateDomainGovernanceRequest) String 

func (request CreateDomainGovernanceRequest) String() string

func (CreateDomainGovernanceRequest) ValidateEnumValue 

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

type CreateDomainGovernanceResponse 

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"`
}

CreateDomainGovernanceResponse wrapper for the CreateDomainGovernance operation

func (CreateDomainGovernanceResponse) HTTPResponse 

func (response CreateDomainGovernanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateDomainGovernanceResponse) String 

func (response CreateDomainGovernanceResponse) String() string

type 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
}

CreateDomainRequest wrapper for the CreateDomain operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/CreateDomain.go.html to see an example of how to use CreateDomainRequest.

func (CreateDomainRequest) BinaryRequestBody 

func (request CreateDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateDomainRequest) HTTPRequest 

func (request CreateDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateDomainRequest) RetryPolicy 

func (request CreateDomainRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateDomainRequest) String 

func (request CreateDomainRequest) String() string

func (CreateDomainRequest) ValidateEnumValue 

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

type CreateDomainResponse 

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"`
}

CreateDomainResponse wrapper for the CreateDomain operation

func (CreateDomainResponse) HTTPResponse 

func (response CreateDomainResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateDomainResponse) String 

func (response CreateDomainResponse) String() string

type CreateSenderInvitationDetails 

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"`
}

CreateSenderInvitationDetails The parameters for creating a sender invitation.

func (CreateSenderInvitationDetails) String 

func (m CreateSenderInvitationDetails) String() string

func (CreateSenderInvitationDetails) ValidateEnumValue 

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

type 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
}

CreateSenderInvitationRequest wrapper for the CreateSenderInvitation operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/CreateSenderInvitation.go.html to see an example of how to use CreateSenderInvitationRequest.

func (CreateSenderInvitationRequest) BinaryRequestBody 

func (request CreateSenderInvitationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateSenderInvitationRequest) HTTPRequest 

func (request CreateSenderInvitationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateSenderInvitationRequest) RetryPolicy 

func (request CreateSenderInvitationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateSenderInvitationRequest) String 

func (request CreateSenderInvitationRequest) String() string

func (CreateSenderInvitationRequest) ValidateEnumValue 

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

type CreateSenderInvitationResponse 

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"`
}

CreateSenderInvitationResponse wrapper for the CreateSenderInvitation operation

func (CreateSenderInvitationResponse) HTTPResponse 

func (response CreateSenderInvitationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateSenderInvitationResponse) String 

func (response CreateSenderInvitationResponse) String() string

type CreateSubscriptionMappingDetails 

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"`
}

CreateSubscriptionMappingDetails CreateSubscriptionMappingDetails contains subscription and compartment identified by the tenancy, and OCID information.

func (CreateSubscriptionMappingDetails) String 

func (m CreateSubscriptionMappingDetails) String() string

func (CreateSubscriptionMappingDetails) ValidateEnumValue 

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

type 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
}

CreateSubscriptionMappingRequest wrapper for the CreateSubscriptionMapping operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/CreateSubscriptionMapping.go.html to see an example of how to use CreateSubscriptionMappingRequest.

func (CreateSubscriptionMappingRequest) BinaryRequestBody 

func (request CreateSubscriptionMappingRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateSubscriptionMappingRequest) HTTPRequest 

func (request CreateSubscriptionMappingRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateSubscriptionMappingRequest) RetryPolicy 

func (request CreateSubscriptionMappingRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateSubscriptionMappingRequest) String 

func (request CreateSubscriptionMappingRequest) String() string

func (CreateSubscriptionMappingRequest) ValidateEnumValue 

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

type CreateSubscriptionMappingResponse 

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"`

	// 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"`
}

CreateSubscriptionMappingResponse wrapper for the CreateSubscriptionMapping operation

func (CreateSubscriptionMappingResponse) HTTPResponse 

func (response CreateSubscriptionMappingResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateSubscriptionMappingResponse) String 

func (response CreateSubscriptionMappingResponse) String() string

type 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
}

DeleteDomainGovernanceRequest wrapper for the DeleteDomainGovernance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/DeleteDomainGovernance.go.html to see an example of how to use DeleteDomainGovernanceRequest.

func (DeleteDomainGovernanceRequest) BinaryRequestBody 

func (request DeleteDomainGovernanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteDomainGovernanceRequest) HTTPRequest 

func (request DeleteDomainGovernanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteDomainGovernanceRequest) RetryPolicy 

func (request DeleteDomainGovernanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteDomainGovernanceRequest) String 

func (request DeleteDomainGovernanceRequest) String() string

func (DeleteDomainGovernanceRequest) ValidateEnumValue 

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

type DeleteDomainGovernanceResponse 

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"`
}

DeleteDomainGovernanceResponse wrapper for the DeleteDomainGovernance operation

func (DeleteDomainGovernanceResponse) HTTPResponse 

func (response DeleteDomainGovernanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteDomainGovernanceResponse) String 

func (response DeleteDomainGovernanceResponse) String() string

type 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
}

DeleteDomainRequest wrapper for the DeleteDomain operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/DeleteDomain.go.html to see an example of how to use DeleteDomainRequest.

func (DeleteDomainRequest) BinaryRequestBody 

func (request DeleteDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteDomainRequest) HTTPRequest 

func (request DeleteDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteDomainRequest) RetryPolicy 

func (request DeleteDomainRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteDomainRequest) String 

func (request DeleteDomainRequest) String() string

func (DeleteDomainRequest) ValidateEnumValue 

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

type DeleteDomainResponse 

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"`
}

DeleteDomainResponse wrapper for the DeleteDomain operation

func (DeleteDomainResponse) HTTPResponse 

func (response DeleteDomainResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteDomainResponse) String 

func (response DeleteDomainResponse) String() string

type 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
}

DeleteLinkRequest wrapper for the DeleteLink operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/DeleteLink.go.html to see an example of how to use DeleteLinkRequest.

func (DeleteLinkRequest) BinaryRequestBody 

func (request DeleteLinkRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteLinkRequest) HTTPRequest 

func (request DeleteLinkRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteLinkRequest) RetryPolicy 

func (request DeleteLinkRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteLinkRequest) String 

func (request DeleteLinkRequest) String() string

func (DeleteLinkRequest) ValidateEnumValue 

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

type DeleteLinkResponse 

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"`
}

DeleteLinkResponse wrapper for the DeleteLink operation

func (DeleteLinkResponse) HTTPResponse 

func (response DeleteLinkResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteLinkResponse) String 

func (response DeleteLinkResponse) String() string

type 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
}

DeleteOrganizationTenancyRequest wrapper for the DeleteOrganizationTenancy operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/DeleteOrganizationTenancy.go.html to see an example of how to use DeleteOrganizationTenancyRequest.

func (DeleteOrganizationTenancyRequest) BinaryRequestBody 

func (request DeleteOrganizationTenancyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteOrganizationTenancyRequest) HTTPRequest 

func (request DeleteOrganizationTenancyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteOrganizationTenancyRequest) RetryPolicy 

func (request DeleteOrganizationTenancyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteOrganizationTenancyRequest) String 

func (request DeleteOrganizationTenancyRequest) String() string

func (DeleteOrganizationTenancyRequest) ValidateEnumValue 

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

type DeleteOrganizationTenancyResponse 

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"`
}

DeleteOrganizationTenancyResponse wrapper for the DeleteOrganizationTenancy operation

func (DeleteOrganizationTenancyResponse) HTTPResponse 

func (response DeleteOrganizationTenancyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteOrganizationTenancyResponse) String 

func (response DeleteOrganizationTenancyResponse) String() string

type 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
}

DeleteSubscriptionMappingRequest wrapper for the DeleteSubscriptionMapping operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/DeleteSubscriptionMapping.go.html to see an example of how to use DeleteSubscriptionMappingRequest.

func (DeleteSubscriptionMappingRequest) BinaryRequestBody 

func (request DeleteSubscriptionMappingRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteSubscriptionMappingRequest) HTTPRequest 

func (request DeleteSubscriptionMappingRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteSubscriptionMappingRequest) RetryPolicy 

func (request DeleteSubscriptionMappingRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteSubscriptionMappingRequest) String 

func (request DeleteSubscriptionMappingRequest) String() string

func (DeleteSubscriptionMappingRequest) ValidateEnumValue 

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

type DeleteSubscriptionMappingResponse 

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"`
}

DeleteSubscriptionMappingResponse wrapper for the DeleteSubscriptionMapping operation

func (DeleteSubscriptionMappingResponse) HTTPResponse 

func (response DeleteSubscriptionMappingResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteSubscriptionMappingResponse) String 

func (response DeleteSubscriptionMappingResponse) String() string

type Domain 

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"`
}

Domain The domain model that is associated with a tenancy.

func (Domain) String 

func (m Domain) String() string

func (Domain) ValidateEnumValue 

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

type DomainClient 

type DomainClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

DomainClient a client for Domain

func NewDomainClientWithConfigurationProvider 

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 

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 (*DomainClient) ConfigurationProvider 

func (client *DomainClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (DomainClient) CreateDomain 

func (client DomainClient) CreateDomain(ctx context.Context, request CreateDomainRequest) (response CreateDomainResponse, err error)

CreateDomain Begins the registration process for claiming a domain.

See also

Click https://docs.cloud.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 (DomainClient) DeleteDomain 

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.

See also

Click https://docs.cloud.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 (DomainClient) GetDomain 

func (client DomainClient) GetDomain(ctx context.Context, request GetDomainRequest) (response GetDomainResponse, err error)

GetDomain Gets information about the domain.

See also

Click https://docs.cloud.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 (DomainClient) ListDomains 

func (client DomainClient) ListDomains(ctx context.Context, request ListDomainsRequest) (response ListDomainsResponse, err error)

ListDomains Return a (paginated) list of domains.

See also

Click https://docs.cloud.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 (*DomainClient) SetRegion 

func (client *DomainClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (DomainClient) UpdateDomain 

func (client DomainClient) UpdateDomain(ctx context.Context, request UpdateDomainRequest) (response UpdateDomainResponse, err error)

UpdateDomain Updates the domain.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/UpdateDomain.go.html to see an example of how to use UpdateDomain API.

type DomainCollection 

type DomainCollection struct {

	// Array containing DomainSummary items.
	Items []DomainSummary `mandatory:"true" json:"items"`
}

DomainCollection Result of a query request for a list of domains. Contains DomainSummary items.

func (DomainCollection) String 

func (m DomainCollection) String() string

func (DomainCollection) ValidateEnumValue 

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

type DomainGovernance 

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"`
}

DomainGovernance The model for a domain governance entity.

func (DomainGovernance) String 

func (m DomainGovernance) String() string

func (DomainGovernance) ValidateEnumValue 

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

type DomainGovernanceClient 

type DomainGovernanceClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

DomainGovernanceClient a client for DomainGovernance

func NewDomainGovernanceClientWithConfigurationProvider 

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 

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 (*DomainGovernanceClient) ConfigurationProvider 

func (client *DomainGovernanceClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (DomainGovernanceClient) CreateDomainGovernance 

func (client DomainGovernanceClient) CreateDomainGovernance(ctx context.Context, request CreateDomainGovernanceRequest) (response CreateDomainGovernanceResponse, err error)

CreateDomainGovernance Adds domain governance to a claimed domain.

See also

Click https://docs.cloud.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 (DomainGovernanceClient) DeleteDomainGovernance 

func (client DomainGovernanceClient) DeleteDomainGovernance(ctx context.Context, request DeleteDomainGovernanceRequest) (response DeleteDomainGovernanceResponse, err error)

DeleteDomainGovernance Removes domain governance from a claimed domain.

See also

Click https://docs.cloud.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 (DomainGovernanceClient) GetDomainGovernance 

func (client DomainGovernanceClient) GetDomainGovernance(ctx context.Context, request GetDomainGovernanceRequest) (response GetDomainGovernanceResponse, err error)

GetDomainGovernance Gets information about the domain governance entity.

See also

Click https://docs.cloud.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 (DomainGovernanceClient) ListDomainGovernances 

func (client DomainGovernanceClient) ListDomainGovernances(ctx context.Context, request ListDomainGovernancesRequest) (response ListDomainGovernancesResponse, err error)

ListDomainGovernances Return a (paginated) list of domain governance entities.

See also

Click https://docs.cloud.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 (*DomainGovernanceClient) SetRegion 

func (client *DomainGovernanceClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (DomainGovernanceClient) UpdateDomainGovernance 

func (client DomainGovernanceClient) UpdateDomainGovernance(ctx context.Context, request UpdateDomainGovernanceRequest) (response UpdateDomainGovernanceResponse, err error)

UpdateDomainGovernance Updates the domain governance entity.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/UpdateDomainGovernance.go.html to see an example of how to use UpdateDomainGovernance API.

type DomainGovernanceCollection 

type DomainGovernanceCollection struct {

	// Array containing DomainGovernanceSummary items.
	Items []DomainGovernanceSummary `mandatory:"true" json:"items"`
}

DomainGovernanceCollection Result of a query request for a list of domain governance entities. Contains DomainGovernanceSummary items.

func (DomainGovernanceCollection) String 

func (m DomainGovernanceCollection) String() string

func (DomainGovernanceCollection) ValidateEnumValue 

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

type DomainGovernanceLifecycleStateEnum 

type DomainGovernanceLifecycleStateEnum string

DomainGovernanceLifecycleStateEnum Enum with underlying type: string 

const (
	DomainGovernanceLifecycleStateActive   DomainGovernanceLifecycleStateEnum = "ACTIVE"
	DomainGovernanceLifecycleStateInactive DomainGovernanceLifecycleStateEnum = "INACTIVE"
)

Set of constants representing the allowable values for DomainGovernanceLifecycleStateEnum

func GetDomainGovernanceLifecycleStateEnumValues 

func GetDomainGovernanceLifecycleStateEnumValues() []DomainGovernanceLifecycleStateEnum

GetDomainGovernanceLifecycleStateEnumValues Enumerates the set of values for DomainGovernanceLifecycleStateEnum

func GetMappingDomainGovernanceLifecycleStateEnum 

func GetMappingDomainGovernanceLifecycleStateEnum(val string) (DomainGovernanceLifecycleStateEnum, bool)

GetMappingDomainGovernanceLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type DomainGovernanceSummary 

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"`
}

DomainGovernanceSummary The summary of a domain govenance entity owned by a tenancy.

func (DomainGovernanceSummary) String 

func (m DomainGovernanceSummary) String() string

func (DomainGovernanceSummary) ValidateEnumValue 

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

type DomainLifecycleStateEnum 

type DomainLifecycleStateEnum string

DomainLifecycleStateEnum Enum with underlying type: string 

const (
	DomainLifecycleStateActive  DomainLifecycleStateEnum = "ACTIVE"
	DomainLifecycleStateDeleted DomainLifecycleStateEnum = "DELETED"
	DomainLifecycleStateFailed  DomainLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for DomainLifecycleStateEnum

func GetDomainLifecycleStateEnumValues 

func GetDomainLifecycleStateEnumValues() []DomainLifecycleStateEnum

GetDomainLifecycleStateEnumValues Enumerates the set of values for DomainLifecycleStateEnum

func GetMappingDomainLifecycleStateEnum 

func GetMappingDomainLifecycleStateEnum(val string) (DomainLifecycleStateEnum, bool)

GetMappingDomainLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type DomainStatusEnum 

type DomainStatusEnum string

DomainStatusEnum Enum with underlying type: string 

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"
)

Set of constants representing the allowable values for DomainStatusEnum

func GetDomainStatusEnumValues 

func GetDomainStatusEnumValues() []DomainStatusEnum

GetDomainStatusEnumValues Enumerates the set of values for DomainStatusEnum

func GetMappingDomainStatusEnum 

func GetMappingDomainStatusEnum(val string) (DomainStatusEnum, bool)

GetMappingDomainStatusEnum performs case Insensitive comparison on enum value and return the desired enum

type DomainSummary 

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"`
}

DomainSummary The summary of a domain owned by a tenancy.

func (DomainSummary) String 

func (m DomainSummary) String() string

func (DomainSummary) ValidateEnumValue 

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

type EntityVersionEnum added in v65.45.0 

type EntityVersionEnum string

EntityVersionEnum Enum with underlying type: string 

const (
	EntityVersionV1 EntityVersionEnum = "V1"
	EntityVersionV2 EntityVersionEnum = "V2"
)

Set of constants representing the allowable values for EntityVersionEnum

func GetEntityVersionEnumValues added in v65.45.0 

func GetEntityVersionEnumValues() []EntityVersionEnum

GetEntityVersionEnumValues Enumerates the set of values for EntityVersionEnum

func GetMappingEntityVersionEnum added in v65.45.0 

func GetMappingEntityVersionEnum(val string) (EntityVersionEnum, bool)

GetMappingEntityVersionEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

GetAssignedSubscriptionRequest wrapper for the GetAssignedSubscription operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetAssignedSubscription.go.html to see an example of how to use GetAssignedSubscriptionRequest.

func (GetAssignedSubscriptionRequest) BinaryRequestBody 

func (request GetAssignedSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetAssignedSubscriptionRequest) HTTPRequest 

func (request GetAssignedSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetAssignedSubscriptionRequest) RetryPolicy 

func (request GetAssignedSubscriptionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetAssignedSubscriptionRequest) String 

func (request GetAssignedSubscriptionRequest) String() string

func (GetAssignedSubscriptionRequest) ValidateEnumValue 

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

type GetAssignedSubscriptionResponse 

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"`
}

GetAssignedSubscriptionResponse wrapper for the GetAssignedSubscription operation

func (GetAssignedSubscriptionResponse) HTTPResponse 

func (response GetAssignedSubscriptionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetAssignedSubscriptionResponse) String 

func (response GetAssignedSubscriptionResponse) String() string

type 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
}

GetDomainGovernanceRequest wrapper for the GetDomainGovernance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetDomainGovernance.go.html to see an example of how to use GetDomainGovernanceRequest.

func (GetDomainGovernanceRequest) BinaryRequestBody 

func (request GetDomainGovernanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetDomainGovernanceRequest) HTTPRequest 

func (request GetDomainGovernanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDomainGovernanceRequest) RetryPolicy 

func (request GetDomainGovernanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetDomainGovernanceRequest) String 

func (request GetDomainGovernanceRequest) String() string

func (GetDomainGovernanceRequest) ValidateEnumValue 

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

type GetDomainGovernanceResponse 

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"`
}

GetDomainGovernanceResponse wrapper for the GetDomainGovernance operation

func (GetDomainGovernanceResponse) HTTPResponse 

func (response GetDomainGovernanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetDomainGovernanceResponse) String 

func (response GetDomainGovernanceResponse) String() string

type 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
}

GetDomainRequest wrapper for the GetDomain operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetDomain.go.html to see an example of how to use GetDomainRequest.

func (GetDomainRequest) BinaryRequestBody 

func (request GetDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetDomainRequest) HTTPRequest 

func (request GetDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDomainRequest) RetryPolicy 

func (request GetDomainRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetDomainRequest) String 

func (request GetDomainRequest) String() string

func (GetDomainRequest) ValidateEnumValue 

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

type GetDomainResponse 

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"`
}

GetDomainResponse wrapper for the GetDomain operation

func (GetDomainResponse) HTTPResponse 

func (response GetDomainResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetDomainResponse) String 

func (response GetDomainResponse) String() string

type 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
}

GetLinkRequest wrapper for the GetLink operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetLink.go.html to see an example of how to use GetLinkRequest.

func (GetLinkRequest) BinaryRequestBody 

func (request GetLinkRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetLinkRequest) HTTPRequest 

func (request GetLinkRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetLinkRequest) RetryPolicy 

func (request GetLinkRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetLinkRequest) String 

func (request GetLinkRequest) String() string

func (GetLinkRequest) ValidateEnumValue 

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

type GetLinkResponse 

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"`
}

GetLinkResponse wrapper for the GetLink operation

func (GetLinkResponse) HTTPResponse 

func (response GetLinkResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetLinkResponse) String 

func (response GetLinkResponse) String() string

type 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
}

GetOrderRequest wrapper for the GetOrder operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetOrder.go.html to see an example of how to use GetOrderRequest.

func (GetOrderRequest) BinaryRequestBody 

func (request GetOrderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetOrderRequest) HTTPRequest 

func (request GetOrderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetOrderRequest) RetryPolicy 

func (request GetOrderRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetOrderRequest) String 

func (request GetOrderRequest) String() string

func (GetOrderRequest) ValidateEnumValue 

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

type GetOrderResponse 

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"`
}

GetOrderResponse wrapper for the GetOrder operation

func (GetOrderResponse) HTTPResponse 

func (response GetOrderResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetOrderResponse) String 

func (response GetOrderResponse) String() string

type 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
}

GetOrganizationRequest wrapper for the GetOrganization operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetOrganization.go.html to see an example of how to use GetOrganizationRequest.

func (GetOrganizationRequest) BinaryRequestBody 

func (request GetOrganizationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetOrganizationRequest) HTTPRequest 

func (request GetOrganizationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetOrganizationRequest) RetryPolicy 

func (request GetOrganizationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetOrganizationRequest) String 

func (request GetOrganizationRequest) String() string

func (GetOrganizationRequest) ValidateEnumValue 

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

type GetOrganizationResponse 

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"`
}

GetOrganizationResponse wrapper for the GetOrganization operation

func (GetOrganizationResponse) HTTPResponse 

func (response GetOrganizationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetOrganizationResponse) String 

func (response GetOrganizationResponse) String() string

type 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
}

GetOrganizationTenancyRequest wrapper for the GetOrganizationTenancy operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetOrganizationTenancy.go.html to see an example of how to use GetOrganizationTenancyRequest.

func (GetOrganizationTenancyRequest) BinaryRequestBody 

func (request GetOrganizationTenancyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetOrganizationTenancyRequest) HTTPRequest 

func (request GetOrganizationTenancyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetOrganizationTenancyRequest) RetryPolicy 

func (request GetOrganizationTenancyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetOrganizationTenancyRequest) String 

func (request GetOrganizationTenancyRequest) String() string

func (GetOrganizationTenancyRequest) ValidateEnumValue 

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

type GetOrganizationTenancyResponse 

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"`
}

GetOrganizationTenancyResponse wrapper for the GetOrganizationTenancy operation

func (GetOrganizationTenancyResponse) HTTPResponse 

func (response GetOrganizationTenancyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetOrganizationTenancyResponse) String 

func (response GetOrganizationTenancyResponse) String() string

type 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
}

GetRecipientInvitationRequest wrapper for the GetRecipientInvitation operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetRecipientInvitation.go.html to see an example of how to use GetRecipientInvitationRequest.

func (GetRecipientInvitationRequest) BinaryRequestBody 

func (request GetRecipientInvitationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetRecipientInvitationRequest) HTTPRequest 

func (request GetRecipientInvitationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetRecipientInvitationRequest) RetryPolicy 

func (request GetRecipientInvitationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetRecipientInvitationRequest) String 

func (request GetRecipientInvitationRequest) String() string

func (GetRecipientInvitationRequest) ValidateEnumValue 

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

type GetRecipientInvitationResponse 

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"`
}

GetRecipientInvitationResponse wrapper for the GetRecipientInvitation operation

func (GetRecipientInvitationResponse) HTTPResponse 

func (response GetRecipientInvitationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetRecipientInvitationResponse) String 

func (response GetRecipientInvitationResponse) String() string

type 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
}

GetSenderInvitationRequest wrapper for the GetSenderInvitation operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetSenderInvitation.go.html to see an example of how to use GetSenderInvitationRequest.

func (GetSenderInvitationRequest) BinaryRequestBody 

func (request GetSenderInvitationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetSenderInvitationRequest) HTTPRequest 

func (request GetSenderInvitationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetSenderInvitationRequest) RetryPolicy 

func (request GetSenderInvitationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetSenderInvitationRequest) String 

func (request GetSenderInvitationRequest) String() string

func (GetSenderInvitationRequest) ValidateEnumValue 

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

type GetSenderInvitationResponse 

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"`
}

GetSenderInvitationResponse wrapper for the GetSenderInvitation operation

func (GetSenderInvitationResponse) HTTPResponse 

func (response GetSenderInvitationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetSenderInvitationResponse) String 

func (response GetSenderInvitationResponse) String() string

type 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
}

GetSubscriptionMappingRequest wrapper for the GetSubscriptionMapping operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetSubscriptionMapping.go.html to see an example of how to use GetSubscriptionMappingRequest.

func (GetSubscriptionMappingRequest) BinaryRequestBody 

func (request GetSubscriptionMappingRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetSubscriptionMappingRequest) HTTPRequest 

func (request GetSubscriptionMappingRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetSubscriptionMappingRequest) RetryPolicy 

func (request GetSubscriptionMappingRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetSubscriptionMappingRequest) String 

func (request GetSubscriptionMappingRequest) String() string

func (GetSubscriptionMappingRequest) ValidateEnumValue 

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

type GetSubscriptionMappingResponse 

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"`
}

GetSubscriptionMappingResponse wrapper for the GetSubscriptionMapping operation

func (GetSubscriptionMappingResponse) HTTPResponse 

func (response GetSubscriptionMappingResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetSubscriptionMappingResponse) String 

func (response GetSubscriptionMappingResponse) String() string

type 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
}

GetSubscriptionRequest wrapper for the GetSubscription operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetSubscription.go.html to see an example of how to use GetSubscriptionRequest.

func (GetSubscriptionRequest) BinaryRequestBody 

func (request GetSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetSubscriptionRequest) HTTPRequest 

func (request GetSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetSubscriptionRequest) RetryPolicy 

func (request GetSubscriptionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetSubscriptionRequest) String 

func (request GetSubscriptionRequest) String() string

func (GetSubscriptionRequest) ValidateEnumValue 

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

type GetSubscriptionResponse 

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"`
}

GetSubscriptionResponse wrapper for the GetSubscription operation

func (GetSubscriptionResponse) HTTPResponse 

func (response GetSubscriptionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetSubscriptionResponse) String 

func (response GetSubscriptionResponse) String() string

type 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
}

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.

func (GetWorkRequestRequest) BinaryRequestBody 

func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest 

func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy 

func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetWorkRequestRequest) String 

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue 

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

type GetWorkRequestResponse 

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"`
}

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse 

func (response GetWorkRequestResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String 

func (response GetWorkRequestResponse) String() string

type GovernanceClient added in v65.36.1 

type GovernanceClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

GovernanceClient a client for Governance

func NewGovernanceClientWithConfigurationProvider added in v65.36.1 

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 added in v65.36.1 

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 (GovernanceClient) AddGovernance added in v65.36.1 

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.

See also

Click https://docs.cloud.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 (*GovernanceClient) ConfigurationProvider added in v65.36.1 

func (client *GovernanceClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (GovernanceClient) RemoveGovernance added in v65.36.1 

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.

See also

Click https://docs.cloud.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 (*GovernanceClient) SetRegion added in v65.36.1 

func (client *GovernanceClient) SetRegion(region string)

SetRegion overrides the region of this client.

type GovernanceStatusEnum added in v65.36.1 

type GovernanceStatusEnum string

GovernanceStatusEnum Enum with underlying type: string 

const (
	GovernanceStatusOptedIn  GovernanceStatusEnum = "OPTED_IN"
	GovernanceStatusOptedOut GovernanceStatusEnum = "OPTED_OUT"
)

Set of constants representing the allowable values for GovernanceStatusEnum

func GetGovernanceStatusEnumValues added in v65.36.1 

func GetGovernanceStatusEnumValues() []GovernanceStatusEnum

GetGovernanceStatusEnumValues Enumerates the set of values for GovernanceStatusEnum

func GetMappingGovernanceStatusEnum added in v65.36.1 

func GetMappingGovernanceStatusEnum(val string) (GovernanceStatusEnum, bool)

GetMappingGovernanceStatusEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

IgnoreRecipientInvitationRequest wrapper for the IgnoreRecipientInvitation operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/IgnoreRecipientInvitation.go.html to see an example of how to use IgnoreRecipientInvitationRequest.

func (IgnoreRecipientInvitationRequest) BinaryRequestBody 

func (request IgnoreRecipientInvitationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (IgnoreRecipientInvitationRequest) HTTPRequest 

func (request IgnoreRecipientInvitationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (IgnoreRecipientInvitationRequest) RetryPolicy 

func (request IgnoreRecipientInvitationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (IgnoreRecipientInvitationRequest) String 

func (request IgnoreRecipientInvitationRequest) String() string

func (IgnoreRecipientInvitationRequest) ValidateEnumValue 

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

type IgnoreRecipientInvitationResponse 

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"`
}

IgnoreRecipientInvitationResponse wrapper for the IgnoreRecipientInvitation operation

func (IgnoreRecipientInvitationResponse) HTTPResponse 

func (response IgnoreRecipientInvitationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (IgnoreRecipientInvitationResponse) String 

func (response IgnoreRecipientInvitationResponse) String() string

type InvitationSubjectEnum added in v65.36.1 

type InvitationSubjectEnum string

InvitationSubjectEnum Enum with underlying type: string 

const (
	InvitationSubjectLink       InvitationSubjectEnum = "LINK"
	InvitationSubjectGovernance InvitationSubjectEnum = "GOVERNANCE"
)

Set of constants representing the allowable values for InvitationSubjectEnum

func GetInvitationSubjectEnumValues added in v65.36.1 

func GetInvitationSubjectEnumValues() []InvitationSubjectEnum

GetInvitationSubjectEnumValues Enumerates the set of values for InvitationSubjectEnum

func GetMappingInvitationSubjectEnum added in v65.36.1 

func GetMappingInvitationSubjectEnum(val string) (InvitationSubjectEnum, bool)

GetMappingInvitationSubjectEnum performs case Insensitive comparison on enum value and return the desired enum

type LifecycleStateEnum 

type LifecycleStateEnum string

LifecycleStateEnum Enum with underlying type: string 

const (
	LifecycleStateCreating   LifecycleStateEnum = "CREATING"
	LifecycleStateActive     LifecycleStateEnum = "ACTIVE"
	LifecycleStateInactive   LifecycleStateEnum = "INACTIVE"
	LifecycleStateUpdating   LifecycleStateEnum = "UPDATING"
	LifecycleStateFailed     LifecycleStateEnum = "FAILED"
	LifecycleStateTerminated LifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for LifecycleStateEnum

func GetLifecycleStateEnumValues 

func GetLifecycleStateEnumValues() []LifecycleStateEnum

GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum

func GetMappingLifecycleStateEnum 

func GetMappingLifecycleStateEnum(val string) (LifecycleStateEnum, bool)

GetMappingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum 

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"`
}

Link A link between a parent tenancy and a child tenancy.

func (Link) String 

func (m Link) String() string

func (Link) ValidateEnumValue 

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

type LinkClient 

type LinkClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

LinkClient a client for Link

func NewLinkClientWithConfigurationProvider 

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 

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 (*LinkClient) ConfigurationProvider 

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.cloud.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.cloud.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.cloud.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 (*LinkClient) SetRegion 

func (client *LinkClient) SetRegion(region string)

SetRegion overrides the region of this client.

type LinkCollection 

type LinkCollection struct {

	// Array containing LinkSummary items.
	Items []LinkSummary `mandatory:"true" json:"items"`
}

LinkCollection Result of a query request for a list of links. Contains Link items.

func (LinkCollection) String 

func (m LinkCollection) String() string

func (LinkCollection) ValidateEnumValue 

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

type LinkSummary 

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"`
}

LinkSummary The summary of a link between a parent tenancy and a child tenancy.

func (LinkSummary) String 

func (m LinkSummary) String() string

func (LinkSummary) ValidateEnumValue 

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

type ListAssignedSubscriptionLineItemsRequest added in v65.45.0 

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
}

ListAssignedSubscriptionLineItemsRequest wrapper for the ListAssignedSubscriptionLineItems operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListAssignedSubscriptionLineItems.go.html to see an example of how to use ListAssignedSubscriptionLineItemsRequest.

func (ListAssignedSubscriptionLineItemsRequest) BinaryRequestBody added in v65.45.0 

func (request ListAssignedSubscriptionLineItemsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListAssignedSubscriptionLineItemsRequest) HTTPRequest added in v65.45.0 

func (request ListAssignedSubscriptionLineItemsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListAssignedSubscriptionLineItemsRequest) RetryPolicy added in v65.45.0 

func (request ListAssignedSubscriptionLineItemsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListAssignedSubscriptionLineItemsRequest) String added in v65.45.0 

func (request ListAssignedSubscriptionLineItemsRequest) String() string

func (ListAssignedSubscriptionLineItemsRequest) ValidateEnumValue added in v65.45.0 

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

type ListAssignedSubscriptionLineItemsResponse added in v65.45.0 

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"`
}

ListAssignedSubscriptionLineItemsResponse wrapper for the ListAssignedSubscriptionLineItems operation

func (ListAssignedSubscriptionLineItemsResponse) HTTPResponse added in v65.45.0 

func (response ListAssignedSubscriptionLineItemsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListAssignedSubscriptionLineItemsResponse) String added in v65.45.0 

func (response ListAssignedSubscriptionLineItemsResponse) String() string

type ListAssignedSubscriptionLineItemsSortByEnum added in v65.45.0 

type ListAssignedSubscriptionLineItemsSortByEnum string

ListAssignedSubscriptionLineItemsSortByEnum Enum with underlying type: string 

const (
	ListAssignedSubscriptionLineItemsSortByTimecreated ListAssignedSubscriptionLineItemsSortByEnum = "timeCreated"
	ListAssignedSubscriptionLineItemsSortByDisplayname ListAssignedSubscriptionLineItemsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListAssignedSubscriptionLineItemsSortByEnum

func GetListAssignedSubscriptionLineItemsSortByEnumValues added in v65.45.0 

func GetListAssignedSubscriptionLineItemsSortByEnumValues() []ListAssignedSubscriptionLineItemsSortByEnum

GetListAssignedSubscriptionLineItemsSortByEnumValues Enumerates the set of values for ListAssignedSubscriptionLineItemsSortByEnum

func GetMappingListAssignedSubscriptionLineItemsSortByEnum added in v65.45.0 

func GetMappingListAssignedSubscriptionLineItemsSortByEnum(val string) (ListAssignedSubscriptionLineItemsSortByEnum, bool)

GetMappingListAssignedSubscriptionLineItemsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListAssignedSubscriptionLineItemsSortOrderEnum added in v65.45.0 

type ListAssignedSubscriptionLineItemsSortOrderEnum string

ListAssignedSubscriptionLineItemsSortOrderEnum Enum with underlying type: string 

const (
	ListAssignedSubscriptionLineItemsSortOrderAsc  ListAssignedSubscriptionLineItemsSortOrderEnum = "ASC"
	ListAssignedSubscriptionLineItemsSortOrderDesc ListAssignedSubscriptionLineItemsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListAssignedSubscriptionLineItemsSortOrderEnum

func GetListAssignedSubscriptionLineItemsSortOrderEnumValues added in v65.45.0 

func GetListAssignedSubscriptionLineItemsSortOrderEnumValues() []ListAssignedSubscriptionLineItemsSortOrderEnum

GetListAssignedSubscriptionLineItemsSortOrderEnumValues Enumerates the set of values for ListAssignedSubscriptionLineItemsSortOrderEnum

func GetMappingListAssignedSubscriptionLineItemsSortOrderEnum added in v65.45.0 

func GetMappingListAssignedSubscriptionLineItemsSortOrderEnum(val string) (ListAssignedSubscriptionLineItemsSortOrderEnum, bool)

GetMappingListAssignedSubscriptionLineItemsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListAssignedSubscriptionsEntityVersionEnum added in v65.45.0 

type ListAssignedSubscriptionsEntityVersionEnum string

ListAssignedSubscriptionsEntityVersionEnum Enum with underlying type: string 

const (
	ListAssignedSubscriptionsEntityVersionV1 ListAssignedSubscriptionsEntityVersionEnum = "V1"
	ListAssignedSubscriptionsEntityVersionV2 ListAssignedSubscriptionsEntityVersionEnum = "V2"
)

Set of constants representing the allowable values for ListAssignedSubscriptionsEntityVersionEnum

func GetListAssignedSubscriptionsEntityVersionEnumValues added in v65.45.0 

func GetListAssignedSubscriptionsEntityVersionEnumValues() []ListAssignedSubscriptionsEntityVersionEnum

GetListAssignedSubscriptionsEntityVersionEnumValues Enumerates the set of values for ListAssignedSubscriptionsEntityVersionEnum

func GetMappingListAssignedSubscriptionsEntityVersionEnum added in v65.45.0 

func GetMappingListAssignedSubscriptionsEntityVersionEnum(val string) (ListAssignedSubscriptionsEntityVersionEnum, bool)

GetMappingListAssignedSubscriptionsEntityVersionEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListAssignedSubscriptionsRequest wrapper for the ListAssignedSubscriptions operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListAssignedSubscriptions.go.html to see an example of how to use ListAssignedSubscriptionsRequest.

func (ListAssignedSubscriptionsRequest) BinaryRequestBody 

func (request ListAssignedSubscriptionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListAssignedSubscriptionsRequest) HTTPRequest 

func (request ListAssignedSubscriptionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListAssignedSubscriptionsRequest) RetryPolicy 

func (request ListAssignedSubscriptionsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListAssignedSubscriptionsRequest) String 

func (request ListAssignedSubscriptionsRequest) String() string

func (ListAssignedSubscriptionsRequest) ValidateEnumValue 

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

type ListAssignedSubscriptionsResponse 

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"`
}

ListAssignedSubscriptionsResponse wrapper for the ListAssignedSubscriptions operation

func (ListAssignedSubscriptionsResponse) HTTPResponse 

func (response ListAssignedSubscriptionsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListAssignedSubscriptionsResponse) String 

func (response ListAssignedSubscriptionsResponse) String() string

type ListAssignedSubscriptionsSortByEnum 

type ListAssignedSubscriptionsSortByEnum string

ListAssignedSubscriptionsSortByEnum Enum with underlying type: string 

const (
	ListAssignedSubscriptionsSortByTimecreated ListAssignedSubscriptionsSortByEnum = "timeCreated"
	ListAssignedSubscriptionsSortByDisplayname ListAssignedSubscriptionsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListAssignedSubscriptionsSortByEnum

func GetListAssignedSubscriptionsSortByEnumValues 

func GetListAssignedSubscriptionsSortByEnumValues() []ListAssignedSubscriptionsSortByEnum

GetListAssignedSubscriptionsSortByEnumValues Enumerates the set of values for ListAssignedSubscriptionsSortByEnum

func GetMappingListAssignedSubscriptionsSortByEnum 

func GetMappingListAssignedSubscriptionsSortByEnum(val string) (ListAssignedSubscriptionsSortByEnum, bool)

GetMappingListAssignedSubscriptionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListAssignedSubscriptionsSortOrderEnum 

type ListAssignedSubscriptionsSortOrderEnum string

ListAssignedSubscriptionsSortOrderEnum Enum with underlying type: string 

const (
	ListAssignedSubscriptionsSortOrderAsc  ListAssignedSubscriptionsSortOrderEnum = "ASC"
	ListAssignedSubscriptionsSortOrderDesc ListAssignedSubscriptionsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListAssignedSubscriptionsSortOrderEnum

func GetListAssignedSubscriptionsSortOrderEnumValues 

func GetListAssignedSubscriptionsSortOrderEnumValues() []ListAssignedSubscriptionsSortOrderEnum

GetListAssignedSubscriptionsSortOrderEnumValues Enumerates the set of values for ListAssignedSubscriptionsSortOrderEnum

func GetMappingListAssignedSubscriptionsSortOrderEnum 

func GetMappingListAssignedSubscriptionsSortOrderEnum(val string) (ListAssignedSubscriptionsSortOrderEnum, bool)

GetMappingListAssignedSubscriptionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListAvailableRegionsRequest wrapper for the ListAvailableRegions operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListAvailableRegions.go.html to see an example of how to use ListAvailableRegionsRequest.

func (ListAvailableRegionsRequest) BinaryRequestBody 

func (request ListAvailableRegionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListAvailableRegionsRequest) HTTPRequest 

func (request ListAvailableRegionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListAvailableRegionsRequest) RetryPolicy 

func (request ListAvailableRegionsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListAvailableRegionsRequest) String 

func (request ListAvailableRegionsRequest) String() string

func (ListAvailableRegionsRequest) ValidateEnumValue 

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

type ListAvailableRegionsResponse 

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"`
}

ListAvailableRegionsResponse wrapper for the ListAvailableRegions operation

func (ListAvailableRegionsResponse) HTTPResponse 

func (response ListAvailableRegionsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListAvailableRegionsResponse) String 

func (response ListAvailableRegionsResponse) String() string

type ListDomainGovernancesLifecycleStateEnum 

type ListDomainGovernancesLifecycleStateEnum string

ListDomainGovernancesLifecycleStateEnum Enum with underlying type: string 

const (
	ListDomainGovernancesLifecycleStateCreating   ListDomainGovernancesLifecycleStateEnum = "CREATING"
	ListDomainGovernancesLifecycleStateActive     ListDomainGovernancesLifecycleStateEnum = "ACTIVE"
	ListDomainGovernancesLifecycleStateInactive   ListDomainGovernancesLifecycleStateEnum = "INACTIVE"
	ListDomainGovernancesLifecycleStateUpdating   ListDomainGovernancesLifecycleStateEnum = "UPDATING"
	ListDomainGovernancesLifecycleStateFailed     ListDomainGovernancesLifecycleStateEnum = "FAILED"
	ListDomainGovernancesLifecycleStateTerminated ListDomainGovernancesLifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for ListDomainGovernancesLifecycleStateEnum

func GetListDomainGovernancesLifecycleStateEnumValues 

func GetListDomainGovernancesLifecycleStateEnumValues() []ListDomainGovernancesLifecycleStateEnum

GetListDomainGovernancesLifecycleStateEnumValues Enumerates the set of values for ListDomainGovernancesLifecycleStateEnum

func GetMappingListDomainGovernancesLifecycleStateEnum 

func GetMappingListDomainGovernancesLifecycleStateEnum(val string) (ListDomainGovernancesLifecycleStateEnum, bool)

GetMappingListDomainGovernancesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListDomainGovernancesRequest wrapper for the ListDomainGovernances operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListDomainGovernances.go.html to see an example of how to use ListDomainGovernancesRequest.

func (ListDomainGovernancesRequest) BinaryRequestBody 

func (request ListDomainGovernancesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListDomainGovernancesRequest) HTTPRequest 

func (request ListDomainGovernancesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListDomainGovernancesRequest) RetryPolicy 

func (request ListDomainGovernancesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListDomainGovernancesRequest) String 

func (request ListDomainGovernancesRequest) String() string

func (ListDomainGovernancesRequest) ValidateEnumValue 

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

type ListDomainGovernancesResponse 

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"`
}

ListDomainGovernancesResponse wrapper for the ListDomainGovernances operation

func (ListDomainGovernancesResponse) HTTPResponse 

func (response ListDomainGovernancesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListDomainGovernancesResponse) String 

func (response ListDomainGovernancesResponse) String() string

type ListDomainGovernancesSortByEnum 

type ListDomainGovernancesSortByEnum string

ListDomainGovernancesSortByEnum Enum with underlying type: string 

const (
	ListDomainGovernancesSortByTimecreated ListDomainGovernancesSortByEnum = "timeCreated"
	ListDomainGovernancesSortByDisplayname ListDomainGovernancesSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListDomainGovernancesSortByEnum

func GetListDomainGovernancesSortByEnumValues 

func GetListDomainGovernancesSortByEnumValues() []ListDomainGovernancesSortByEnum

GetListDomainGovernancesSortByEnumValues Enumerates the set of values for ListDomainGovernancesSortByEnum

func GetMappingListDomainGovernancesSortByEnum 

func GetMappingListDomainGovernancesSortByEnum(val string) (ListDomainGovernancesSortByEnum, bool)

GetMappingListDomainGovernancesSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDomainGovernancesSortOrderEnum 

type ListDomainGovernancesSortOrderEnum string

ListDomainGovernancesSortOrderEnum Enum with underlying type: string 

const (
	ListDomainGovernancesSortOrderAsc  ListDomainGovernancesSortOrderEnum = "ASC"
	ListDomainGovernancesSortOrderDesc ListDomainGovernancesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDomainGovernancesSortOrderEnum

func GetListDomainGovernancesSortOrderEnumValues 

func GetListDomainGovernancesSortOrderEnumValues() []ListDomainGovernancesSortOrderEnum

GetListDomainGovernancesSortOrderEnumValues Enumerates the set of values for ListDomainGovernancesSortOrderEnum

func GetMappingListDomainGovernancesSortOrderEnum 

func GetMappingListDomainGovernancesSortOrderEnum(val string) (ListDomainGovernancesSortOrderEnum, bool)

GetMappingListDomainGovernancesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDomainsLifecycleStateEnum 

type ListDomainsLifecycleStateEnum string

ListDomainsLifecycleStateEnum Enum with underlying type: string 

const (
	ListDomainsLifecycleStateCreating   ListDomainsLifecycleStateEnum = "CREATING"
	ListDomainsLifecycleStateActive     ListDomainsLifecycleStateEnum = "ACTIVE"
	ListDomainsLifecycleStateInactive   ListDomainsLifecycleStateEnum = "INACTIVE"
	ListDomainsLifecycleStateUpdating   ListDomainsLifecycleStateEnum = "UPDATING"
	ListDomainsLifecycleStateFailed     ListDomainsLifecycleStateEnum = "FAILED"
	ListDomainsLifecycleStateTerminated ListDomainsLifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for ListDomainsLifecycleStateEnum

func GetListDomainsLifecycleStateEnumValues 

func GetListDomainsLifecycleStateEnumValues() []ListDomainsLifecycleStateEnum

GetListDomainsLifecycleStateEnumValues Enumerates the set of values for ListDomainsLifecycleStateEnum

func GetMappingListDomainsLifecycleStateEnum 

func GetMappingListDomainsLifecycleStateEnum(val string) (ListDomainsLifecycleStateEnum, bool)

GetMappingListDomainsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListDomainsRequest wrapper for the ListDomains operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListDomains.go.html to see an example of how to use ListDomainsRequest.

func (ListDomainsRequest) BinaryRequestBody 

func (request ListDomainsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListDomainsRequest) HTTPRequest 

func (request ListDomainsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListDomainsRequest) RetryPolicy 

func (request ListDomainsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListDomainsRequest) String 

func (request ListDomainsRequest) String() string

func (ListDomainsRequest) ValidateEnumValue 

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

type ListDomainsResponse 

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"`
}

ListDomainsResponse wrapper for the ListDomains operation

func (ListDomainsResponse) HTTPResponse 

func (response ListDomainsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListDomainsResponse) String 

func (response ListDomainsResponse) String() string

type ListDomainsSortByEnum 

type ListDomainsSortByEnum string

ListDomainsSortByEnum Enum with underlying type: string 

const (
	ListDomainsSortByTimecreated ListDomainsSortByEnum = "timeCreated"
	ListDomainsSortByDisplayname ListDomainsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListDomainsSortByEnum

func GetListDomainsSortByEnumValues 

func GetListDomainsSortByEnumValues() []ListDomainsSortByEnum

GetListDomainsSortByEnumValues Enumerates the set of values for ListDomainsSortByEnum

func GetMappingListDomainsSortByEnum 

func GetMappingListDomainsSortByEnum(val string) (ListDomainsSortByEnum, bool)

GetMappingListDomainsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDomainsSortOrderEnum 

type ListDomainsSortOrderEnum string

ListDomainsSortOrderEnum Enum with underlying type: string 

const (
	ListDomainsSortOrderAsc  ListDomainsSortOrderEnum = "ASC"
	ListDomainsSortOrderDesc ListDomainsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDomainsSortOrderEnum

func GetListDomainsSortOrderEnumValues 

func GetListDomainsSortOrderEnumValues() []ListDomainsSortOrderEnum

GetListDomainsSortOrderEnumValues Enumerates the set of values for ListDomainsSortOrderEnum

func GetMappingListDomainsSortOrderEnum 

func GetMappingListDomainsSortOrderEnum(val string) (ListDomainsSortOrderEnum, bool)

GetMappingListDomainsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListLinksLifecycleStateEnum 

type ListLinksLifecycleStateEnum string

ListLinksLifecycleStateEnum Enum with underlying type: string 

const (
	ListLinksLifecycleStateCreating   ListLinksLifecycleStateEnum = "CREATING"
	ListLinksLifecycleStateActive     ListLinksLifecycleStateEnum = "ACTIVE"
	ListLinksLifecycleStateInactive   ListLinksLifecycleStateEnum = "INACTIVE"
	ListLinksLifecycleStateUpdating   ListLinksLifecycleStateEnum = "UPDATING"
	ListLinksLifecycleStateFailed     ListLinksLifecycleStateEnum = "FAILED"
	ListLinksLifecycleStateTerminated ListLinksLifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for ListLinksLifecycleStateEnum

func GetListLinksLifecycleStateEnumValues 

func GetListLinksLifecycleStateEnumValues() []ListLinksLifecycleStateEnum

GetListLinksLifecycleStateEnumValues Enumerates the set of values for ListLinksLifecycleStateEnum

func GetMappingListLinksLifecycleStateEnum 

func GetMappingListLinksLifecycleStateEnum(val string) (ListLinksLifecycleStateEnum, bool)

GetMappingListLinksLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListLinksRequest wrapper for the ListLinks operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListLinks.go.html to see an example of how to use ListLinksRequest.

func (ListLinksRequest) BinaryRequestBody 

func (request ListLinksRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListLinksRequest) HTTPRequest 

func (request ListLinksRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListLinksRequest) RetryPolicy 

func (request ListLinksRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListLinksRequest) String 

func (request ListLinksRequest) String() string

func (ListLinksRequest) ValidateEnumValue 

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

type ListLinksResponse 

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"`
}

ListLinksResponse wrapper for the ListLinks operation

func (ListLinksResponse) HTTPResponse 

func (response ListLinksResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListLinksResponse) String 

func (response ListLinksResponse) String() string

type ListLinksSortOrderEnum 

type ListLinksSortOrderEnum string

ListLinksSortOrderEnum Enum with underlying type: string 

const (
	ListLinksSortOrderAsc  ListLinksSortOrderEnum = "ASC"
	ListLinksSortOrderDesc ListLinksSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListLinksSortOrderEnum

func GetListLinksSortOrderEnumValues 

func GetListLinksSortOrderEnumValues() []ListLinksSortOrderEnum

GetListLinksSortOrderEnumValues Enumerates the set of values for ListLinksSortOrderEnum

func GetMappingListLinksSortOrderEnum 

func GetMappingListLinksSortOrderEnum(val string) (ListLinksSortOrderEnum, bool)

GetMappingListLinksSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListOrganizationTenanciesRequest wrapper for the ListOrganizationTenancies operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListOrganizationTenancies.go.html to see an example of how to use ListOrganizationTenanciesRequest.

func (ListOrganizationTenanciesRequest) BinaryRequestBody 

func (request ListOrganizationTenanciesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListOrganizationTenanciesRequest) HTTPRequest 

func (request ListOrganizationTenanciesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListOrganizationTenanciesRequest) RetryPolicy 

func (request ListOrganizationTenanciesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListOrganizationTenanciesRequest) String 

func (request ListOrganizationTenanciesRequest) String() string

func (ListOrganizationTenanciesRequest) ValidateEnumValue 

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

type ListOrganizationTenanciesResponse 

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"`
}

ListOrganizationTenanciesResponse wrapper for the ListOrganizationTenancies operation

func (ListOrganizationTenanciesResponse) HTTPResponse 

func (response ListOrganizationTenanciesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListOrganizationTenanciesResponse) String 

func (response ListOrganizationTenanciesResponse) String() string

type 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
}

ListOrganizationsRequest wrapper for the ListOrganizations operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListOrganizations.go.html to see an example of how to use ListOrganizationsRequest.

func (ListOrganizationsRequest) BinaryRequestBody 

func (request ListOrganizationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListOrganizationsRequest) HTTPRequest 

func (request ListOrganizationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListOrganizationsRequest) RetryPolicy 

func (request ListOrganizationsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListOrganizationsRequest) String 

func (request ListOrganizationsRequest) String() string

func (ListOrganizationsRequest) ValidateEnumValue 

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

type ListOrganizationsResponse 

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"`
}

ListOrganizationsResponse wrapper for the ListOrganizations operation

func (ListOrganizationsResponse) HTTPResponse 

func (response ListOrganizationsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListOrganizationsResponse) String 

func (response ListOrganizationsResponse) String() string

type ListRecipientInvitationsLifecycleStateEnum 

type ListRecipientInvitationsLifecycleStateEnum string

ListRecipientInvitationsLifecycleStateEnum Enum with underlying type: string 

const (
	ListRecipientInvitationsLifecycleStateCreating   ListRecipientInvitationsLifecycleStateEnum = "CREATING"
	ListRecipientInvitationsLifecycleStateActive     ListRecipientInvitationsLifecycleStateEnum = "ACTIVE"
	ListRecipientInvitationsLifecycleStateInactive   ListRecipientInvitationsLifecycleStateEnum = "INACTIVE"
	ListRecipientInvitationsLifecycleStateUpdating   ListRecipientInvitationsLifecycleStateEnum = "UPDATING"
	ListRecipientInvitationsLifecycleStateFailed     ListRecipientInvitationsLifecycleStateEnum = "FAILED"
	ListRecipientInvitationsLifecycleStateTerminated ListRecipientInvitationsLifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for ListRecipientInvitationsLifecycleStateEnum

func GetListRecipientInvitationsLifecycleStateEnumValues 

func GetListRecipientInvitationsLifecycleStateEnumValues() []ListRecipientInvitationsLifecycleStateEnum

GetListRecipientInvitationsLifecycleStateEnumValues Enumerates the set of values for ListRecipientInvitationsLifecycleStateEnum

func GetMappingListRecipientInvitationsLifecycleStateEnum 

func GetMappingListRecipientInvitationsLifecycleStateEnum(val string) (ListRecipientInvitationsLifecycleStateEnum, bool)

GetMappingListRecipientInvitationsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListRecipientInvitationsRequest wrapper for the ListRecipientInvitations operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListRecipientInvitations.go.html to see an example of how to use ListRecipientInvitationsRequest.

func (ListRecipientInvitationsRequest) BinaryRequestBody 

func (request ListRecipientInvitationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListRecipientInvitationsRequest) HTTPRequest 

func (request ListRecipientInvitationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListRecipientInvitationsRequest) RetryPolicy 

func (request ListRecipientInvitationsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListRecipientInvitationsRequest) String 

func (request ListRecipientInvitationsRequest) String() string

func (ListRecipientInvitationsRequest) ValidateEnumValue 

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

type ListRecipientInvitationsResponse 

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"`
}

ListRecipientInvitationsResponse wrapper for the ListRecipientInvitations operation

func (ListRecipientInvitationsResponse) HTTPResponse 

func (response ListRecipientInvitationsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListRecipientInvitationsResponse) String 

func (response ListRecipientInvitationsResponse) String() string

type ListRecipientInvitationsStatusEnum 

type ListRecipientInvitationsStatusEnum string

ListRecipientInvitationsStatusEnum Enum with underlying type: string 

const (
	ListRecipientInvitationsStatusPending  ListRecipientInvitationsStatusEnum = "PENDING"
	ListRecipientInvitationsStatusCanceled ListRecipientInvitationsStatusEnum = "CANCELED"
	ListRecipientInvitationsStatusAccepted ListRecipientInvitationsStatusEnum = "ACCEPTED"
	ListRecipientInvitationsStatusIgnored  ListRecipientInvitationsStatusEnum = "IGNORED"
	ListRecipientInvitationsStatusExpired  ListRecipientInvitationsStatusEnum = "EXPIRED"
	ListRecipientInvitationsStatusFailed   ListRecipientInvitationsStatusEnum = "FAILED"
)

Set of constants representing the allowable values for ListRecipientInvitationsStatusEnum

func GetListRecipientInvitationsStatusEnumValues 

func GetListRecipientInvitationsStatusEnumValues() []ListRecipientInvitationsStatusEnum

GetListRecipientInvitationsStatusEnumValues Enumerates the set of values for ListRecipientInvitationsStatusEnum

func GetMappingListRecipientInvitationsStatusEnum 

func GetMappingListRecipientInvitationsStatusEnum(val string) (ListRecipientInvitationsStatusEnum, bool)

GetMappingListRecipientInvitationsStatusEnum performs case Insensitive comparison on enum value and return the desired enum

type ListSenderInvitationsLifecycleStateEnum 

type ListSenderInvitationsLifecycleStateEnum string

ListSenderInvitationsLifecycleStateEnum Enum with underlying type: string 

const (
	ListSenderInvitationsLifecycleStateCreating   ListSenderInvitationsLifecycleStateEnum = "CREATING"
	ListSenderInvitationsLifecycleStateActive     ListSenderInvitationsLifecycleStateEnum = "ACTIVE"
	ListSenderInvitationsLifecycleStateInactive   ListSenderInvitationsLifecycleStateEnum = "INACTIVE"
	ListSenderInvitationsLifecycleStateUpdating   ListSenderInvitationsLifecycleStateEnum = "UPDATING"
	ListSenderInvitationsLifecycleStateFailed     ListSenderInvitationsLifecycleStateEnum = "FAILED"
	ListSenderInvitationsLifecycleStateTerminated ListSenderInvitationsLifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for ListSenderInvitationsLifecycleStateEnum

func GetListSenderInvitationsLifecycleStateEnumValues 

func GetListSenderInvitationsLifecycleStateEnumValues() []ListSenderInvitationsLifecycleStateEnum

GetListSenderInvitationsLifecycleStateEnumValues Enumerates the set of values for ListSenderInvitationsLifecycleStateEnum

func GetMappingListSenderInvitationsLifecycleStateEnum 

func GetMappingListSenderInvitationsLifecycleStateEnum(val string) (ListSenderInvitationsLifecycleStateEnum, bool)

GetMappingListSenderInvitationsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListSenderInvitationsRequest wrapper for the ListSenderInvitations operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListSenderInvitations.go.html to see an example of how to use ListSenderInvitationsRequest.

func (ListSenderInvitationsRequest) BinaryRequestBody 

func (request ListSenderInvitationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListSenderInvitationsRequest) HTTPRequest 

func (request ListSenderInvitationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListSenderInvitationsRequest) RetryPolicy 

func (request ListSenderInvitationsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListSenderInvitationsRequest) String 

func (request ListSenderInvitationsRequest) String() string

func (ListSenderInvitationsRequest) ValidateEnumValue 

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

type ListSenderInvitationsResponse 

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"`
}

ListSenderInvitationsResponse wrapper for the ListSenderInvitations operation

func (ListSenderInvitationsResponse) HTTPResponse 

func (response ListSenderInvitationsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListSenderInvitationsResponse) String 

func (response ListSenderInvitationsResponse) String() string

type ListSenderInvitationsSortByEnum 

type ListSenderInvitationsSortByEnum string

ListSenderInvitationsSortByEnum Enum with underlying type: string 

const (
	ListSenderInvitationsSortByTimecreated ListSenderInvitationsSortByEnum = "timeCreated"
	ListSenderInvitationsSortByDisplayname ListSenderInvitationsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListSenderInvitationsSortByEnum

func GetListSenderInvitationsSortByEnumValues 

func GetListSenderInvitationsSortByEnumValues() []ListSenderInvitationsSortByEnum

GetListSenderInvitationsSortByEnumValues Enumerates the set of values for ListSenderInvitationsSortByEnum

func GetMappingListSenderInvitationsSortByEnum 

func GetMappingListSenderInvitationsSortByEnum(val string) (ListSenderInvitationsSortByEnum, bool)

GetMappingListSenderInvitationsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListSenderInvitationsSortOrderEnum 

type ListSenderInvitationsSortOrderEnum string

ListSenderInvitationsSortOrderEnum Enum with underlying type: string 

const (
	ListSenderInvitationsSortOrderAsc  ListSenderInvitationsSortOrderEnum = "ASC"
	ListSenderInvitationsSortOrderDesc ListSenderInvitationsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListSenderInvitationsSortOrderEnum

func GetListSenderInvitationsSortOrderEnumValues 

func GetListSenderInvitationsSortOrderEnumValues() []ListSenderInvitationsSortOrderEnum

GetListSenderInvitationsSortOrderEnumValues Enumerates the set of values for ListSenderInvitationsSortOrderEnum

func GetMappingListSenderInvitationsSortOrderEnum 

func GetMappingListSenderInvitationsSortOrderEnum(val string) (ListSenderInvitationsSortOrderEnum, bool)

GetMappingListSenderInvitationsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListSenderInvitationsStatusEnum 

type ListSenderInvitationsStatusEnum string

ListSenderInvitationsStatusEnum Enum with underlying type: string 

const (
	ListSenderInvitationsStatusPending  ListSenderInvitationsStatusEnum = "PENDING"
	ListSenderInvitationsStatusCanceled ListSenderInvitationsStatusEnum = "CANCELED"
	ListSenderInvitationsStatusAccepted ListSenderInvitationsStatusEnum = "ACCEPTED"
	ListSenderInvitationsStatusExpired  ListSenderInvitationsStatusEnum = "EXPIRED"
	ListSenderInvitationsStatusFailed   ListSenderInvitationsStatusEnum = "FAILED"
)

Set of constants representing the allowable values for ListSenderInvitationsStatusEnum

func GetListSenderInvitationsStatusEnumValues 

func GetListSenderInvitationsStatusEnumValues() []ListSenderInvitationsStatusEnum

GetListSenderInvitationsStatusEnumValues Enumerates the set of values for ListSenderInvitationsStatusEnum

func GetMappingListSenderInvitationsStatusEnum 

func GetMappingListSenderInvitationsStatusEnum(val string) (ListSenderInvitationsStatusEnum, bool)

GetMappingListSenderInvitationsStatusEnum performs case Insensitive comparison on enum value and return the desired enum

type ListSubscriptionLineItemsRequest added in v65.45.0 

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
}

ListSubscriptionLineItemsRequest wrapper for the ListSubscriptionLineItems operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListSubscriptionLineItems.go.html to see an example of how to use ListSubscriptionLineItemsRequest.

func (ListSubscriptionLineItemsRequest) BinaryRequestBody added in v65.45.0 

func (request ListSubscriptionLineItemsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListSubscriptionLineItemsRequest) HTTPRequest added in v65.45.0 

func (request ListSubscriptionLineItemsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListSubscriptionLineItemsRequest) RetryPolicy added in v65.45.0 

func (request ListSubscriptionLineItemsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListSubscriptionLineItemsRequest) String added in v65.45.0 

func (request ListSubscriptionLineItemsRequest) String() string

func (ListSubscriptionLineItemsRequest) ValidateEnumValue added in v65.45.0 

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

type ListSubscriptionLineItemsResponse added in v65.45.0 

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"`
}

ListSubscriptionLineItemsResponse wrapper for the ListSubscriptionLineItems operation

func (ListSubscriptionLineItemsResponse) HTTPResponse added in v65.45.0 

func (response ListSubscriptionLineItemsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListSubscriptionLineItemsResponse) String added in v65.45.0 

func (response ListSubscriptionLineItemsResponse) String() string

type ListSubscriptionLineItemsSortByEnum added in v65.45.0 

type ListSubscriptionLineItemsSortByEnum string

ListSubscriptionLineItemsSortByEnum Enum with underlying type: string 

const (
	ListSubscriptionLineItemsSortByTimecreated ListSubscriptionLineItemsSortByEnum = "timeCreated"
	ListSubscriptionLineItemsSortByDisplayname ListSubscriptionLineItemsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListSubscriptionLineItemsSortByEnum

func GetListSubscriptionLineItemsSortByEnumValues added in v65.45.0 

func GetListSubscriptionLineItemsSortByEnumValues() []ListSubscriptionLineItemsSortByEnum

GetListSubscriptionLineItemsSortByEnumValues Enumerates the set of values for ListSubscriptionLineItemsSortByEnum

func GetMappingListSubscriptionLineItemsSortByEnum added in v65.45.0 

func GetMappingListSubscriptionLineItemsSortByEnum(val string) (ListSubscriptionLineItemsSortByEnum, bool)

GetMappingListSubscriptionLineItemsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListSubscriptionLineItemsSortOrderEnum added in v65.45.0 

type ListSubscriptionLineItemsSortOrderEnum string

ListSubscriptionLineItemsSortOrderEnum Enum with underlying type: string 

const (
	ListSubscriptionLineItemsSortOrderAsc  ListSubscriptionLineItemsSortOrderEnum = "ASC"
	ListSubscriptionLineItemsSortOrderDesc ListSubscriptionLineItemsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListSubscriptionLineItemsSortOrderEnum

func GetListSubscriptionLineItemsSortOrderEnumValues added in v65.45.0 

func GetListSubscriptionLineItemsSortOrderEnumValues() []ListSubscriptionLineItemsSortOrderEnum

GetListSubscriptionLineItemsSortOrderEnumValues Enumerates the set of values for ListSubscriptionLineItemsSortOrderEnum

func GetMappingListSubscriptionLineItemsSortOrderEnum added in v65.45.0 

func GetMappingListSubscriptionLineItemsSortOrderEnum(val string) (ListSubscriptionLineItemsSortOrderEnum, bool)

GetMappingListSubscriptionLineItemsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListSubscriptionMappingsRequest wrapper for the ListSubscriptionMappings operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListSubscriptionMappings.go.html to see an example of how to use ListSubscriptionMappingsRequest.

func (ListSubscriptionMappingsRequest) BinaryRequestBody 

func (request ListSubscriptionMappingsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListSubscriptionMappingsRequest) HTTPRequest 

func (request ListSubscriptionMappingsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListSubscriptionMappingsRequest) RetryPolicy 

func (request ListSubscriptionMappingsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListSubscriptionMappingsRequest) String 

func (request ListSubscriptionMappingsRequest) String() string

func (ListSubscriptionMappingsRequest) ValidateEnumValue 

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

type ListSubscriptionMappingsResponse 

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"`
}

ListSubscriptionMappingsResponse wrapper for the ListSubscriptionMappings operation

func (ListSubscriptionMappingsResponse) HTTPResponse 

func (response ListSubscriptionMappingsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListSubscriptionMappingsResponse) String 

func (response ListSubscriptionMappingsResponse) String() string

type ListSubscriptionMappingsSortByEnum 

type ListSubscriptionMappingsSortByEnum string

ListSubscriptionMappingsSortByEnum Enum with underlying type: string 

const (
	ListSubscriptionMappingsSortByTimecreated ListSubscriptionMappingsSortByEnum = "timeCreated"
	ListSubscriptionMappingsSortByDisplayname ListSubscriptionMappingsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListSubscriptionMappingsSortByEnum

func GetListSubscriptionMappingsSortByEnumValues 

func GetListSubscriptionMappingsSortByEnumValues() []ListSubscriptionMappingsSortByEnum

GetListSubscriptionMappingsSortByEnumValues Enumerates the set of values for ListSubscriptionMappingsSortByEnum

func GetMappingListSubscriptionMappingsSortByEnum 

func GetMappingListSubscriptionMappingsSortByEnum(val string) (ListSubscriptionMappingsSortByEnum, bool)

GetMappingListSubscriptionMappingsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListSubscriptionMappingsSortOrderEnum 

type ListSubscriptionMappingsSortOrderEnum string

ListSubscriptionMappingsSortOrderEnum Enum with underlying type: string 

const (
	ListSubscriptionMappingsSortOrderAsc  ListSubscriptionMappingsSortOrderEnum = "ASC"
	ListSubscriptionMappingsSortOrderDesc ListSubscriptionMappingsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListSubscriptionMappingsSortOrderEnum

func GetListSubscriptionMappingsSortOrderEnumValues 

func GetListSubscriptionMappingsSortOrderEnumValues() []ListSubscriptionMappingsSortOrderEnum

GetListSubscriptionMappingsSortOrderEnumValues Enumerates the set of values for ListSubscriptionMappingsSortOrderEnum

func GetMappingListSubscriptionMappingsSortOrderEnum 

func GetMappingListSubscriptionMappingsSortOrderEnum(val string) (ListSubscriptionMappingsSortOrderEnum, bool)

GetMappingListSubscriptionMappingsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListSubscriptionsEntityVersionEnum added in v65.45.0 

type ListSubscriptionsEntityVersionEnum string

ListSubscriptionsEntityVersionEnum Enum with underlying type: string 

const (
	ListSubscriptionsEntityVersionV1 ListSubscriptionsEntityVersionEnum = "V1"
	ListSubscriptionsEntityVersionV2 ListSubscriptionsEntityVersionEnum = "V2"
)

Set of constants representing the allowable values for ListSubscriptionsEntityVersionEnum

func GetListSubscriptionsEntityVersionEnumValues added in v65.45.0 

func GetListSubscriptionsEntityVersionEnumValues() []ListSubscriptionsEntityVersionEnum

GetListSubscriptionsEntityVersionEnumValues Enumerates the set of values for ListSubscriptionsEntityVersionEnum

func GetMappingListSubscriptionsEntityVersionEnum added in v65.45.0 

func GetMappingListSubscriptionsEntityVersionEnum(val string) (ListSubscriptionsEntityVersionEnum, bool)

GetMappingListSubscriptionsEntityVersionEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListSubscriptionsRequest wrapper for the ListSubscriptions operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListSubscriptions.go.html to see an example of how to use ListSubscriptionsRequest.

func (ListSubscriptionsRequest) BinaryRequestBody 

func (request ListSubscriptionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListSubscriptionsRequest) HTTPRequest 

func (request ListSubscriptionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListSubscriptionsRequest) RetryPolicy 

func (request ListSubscriptionsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListSubscriptionsRequest) String 

func (request ListSubscriptionsRequest) String() string

func (ListSubscriptionsRequest) ValidateEnumValue 

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

type ListSubscriptionsResponse 

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"`
}

ListSubscriptionsResponse wrapper for the ListSubscriptions operation

func (ListSubscriptionsResponse) HTTPResponse 

func (response ListSubscriptionsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListSubscriptionsResponse) String 

func (response ListSubscriptionsResponse) String() string

type ListSubscriptionsSortByEnum 

type ListSubscriptionsSortByEnum string

ListSubscriptionsSortByEnum Enum with underlying type: string 

const (
	ListSubscriptionsSortByTimecreated ListSubscriptionsSortByEnum = "timeCreated"
	ListSubscriptionsSortByDisplayname ListSubscriptionsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListSubscriptionsSortByEnum

func GetListSubscriptionsSortByEnumValues 

func GetListSubscriptionsSortByEnumValues() []ListSubscriptionsSortByEnum

GetListSubscriptionsSortByEnumValues Enumerates the set of values for ListSubscriptionsSortByEnum

func GetMappingListSubscriptionsSortByEnum 

func GetMappingListSubscriptionsSortByEnum(val string) (ListSubscriptionsSortByEnum, bool)

GetMappingListSubscriptionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListSubscriptionsSortOrderEnum 

type ListSubscriptionsSortOrderEnum string

ListSubscriptionsSortOrderEnum Enum with underlying type: string 

const (
	ListSubscriptionsSortOrderAsc  ListSubscriptionsSortOrderEnum = "ASC"
	ListSubscriptionsSortOrderDesc ListSubscriptionsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListSubscriptionsSortOrderEnum

func GetListSubscriptionsSortOrderEnumValues 

func GetListSubscriptionsSortOrderEnumValues() []ListSubscriptionsSortOrderEnum

GetListSubscriptionsSortOrderEnumValues Enumerates the set of values for ListSubscriptionsSortOrderEnum

func GetMappingListSubscriptionsSortOrderEnum 

func GetMappingListSubscriptionsSortOrderEnum(val string) (ListSubscriptionsSortOrderEnum, bool)

GetMappingListSubscriptionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.

func (ListWorkRequestErrorsRequest) BinaryRequestBody 

func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest 

func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy 

func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestErrorsRequest) String 

func (request ListWorkRequestErrorsRequest) String() string

func (ListWorkRequestErrorsRequest) ValidateEnumValue 

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

type ListWorkRequestErrorsResponse 

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"`
}

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse 

func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String 

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortOrderEnum 

type ListWorkRequestErrorsSortOrderEnum string

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string 

const (
	ListWorkRequestErrorsSortOrderAsc  ListWorkRequestErrorsSortOrderEnum = "ASC"
	ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestErrorsSortOrderEnumValues 

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum 

func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)

GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.

func (ListWorkRequestLogsRequest) BinaryRequestBody 

func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest 

func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy 

func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestLogsRequest) String 

func (request ListWorkRequestLogsRequest) String() string

func (ListWorkRequestLogsRequest) ValidateEnumValue 

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

type ListWorkRequestLogsResponse 

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"`
}

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse 

func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String 

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortOrderEnum 

type ListWorkRequestLogsSortOrderEnum string

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string 

const (
	ListWorkRequestLogsSortOrderAsc  ListWorkRequestLogsSortOrderEnum = "ASC"
	ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestLogsSortOrderEnumValues 

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum 

func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)

GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.

func (ListWorkRequestsRequest) BinaryRequestBody 

func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest 

func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy 

func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestsRequest) String 

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue 

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

type ListWorkRequestsResponse 

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"`
}

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse 

func (response ListWorkRequestsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String 

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortOrderEnum 

type ListWorkRequestsSortOrderEnum string

ListWorkRequestsSortOrderEnum Enum with underlying type: string 

const (
	ListWorkRequestsSortOrderAsc  ListWorkRequestsSortOrderEnum = "ASC"
	ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsSortOrderEnumValues 

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum 

func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)

GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type OperationStatusEnum 

type OperationStatusEnum string

OperationStatusEnum Enum with underlying type: string 

const (
	OperationStatusAccepted   OperationStatusEnum = "ACCEPTED"
	OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
	OperationStatusFailed     OperationStatusEnum = "FAILED"
	OperationStatusSucceeded  OperationStatusEnum = "SUCCEEDED"
	OperationStatusCanceling  OperationStatusEnum = "CANCELING"
	OperationStatusCanceled   OperationStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for OperationStatusEnum

func GetMappingOperationStatusEnum 

func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)

GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOperationStatusEnumValues 

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypeEnum 

type OperationTypeEnum string

OperationTypeEnum Enum with underlying type: string 

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"
	OperationTypeSelfOptIn                    OperationTypeEnum = "SELF_OPT_IN"
	OperationTypeSelfOptOut                   OperationTypeEnum = "SELF_OPT_OUT"
)

Set of constants representing the allowable values for OperationTypeEnum

func GetMappingOperationTypeEnum 

func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)

GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOperationTypeEnumValues 

func GetOperationTypeEnumValues() []OperationTypeEnum

GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum

type Order 

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"`
}

Order Order details.

func (Order) String 

func (m Order) String() string

func (Order) ValidateEnumValue 

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

type OrdersClient 

type OrdersClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

OrdersClient a client for Orders

func NewOrdersClientWithConfigurationProvider 

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 

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 (OrdersClient) ActivateOrder 

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.

See also

Click https://docs.cloud.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 (*OrdersClient) ConfigurationProvider 

func (client *OrdersClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (OrdersClient) GetOrder 

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.

See also

Click https://docs.cloud.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 (*OrdersClient) SetRegion 

func (client *OrdersClient) SetRegion(region string)

SetRegion overrides the region of this client.

type Organization 

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"`
}

Organization An organization entity.

func (Organization) String 

func (m Organization) String() string

func (Organization) ValidateEnumValue 

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

type OrganizationClient 

type OrganizationClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

OrganizationClient a client for Organization

func NewOrganizationClientWithConfigurationProvider 

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 

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 (OrganizationClient) ApproveOrganizationTenancyForTransfer 

func (client OrganizationClient) ApproveOrganizationTenancyForTransfer(ctx context.Context, request ApproveOrganizationTenancyForTransferRequest) (response ApproveOrganizationTenancyForTransferResponse, err error)

ApproveOrganizationTenancyForTransfer Approve an organization's child tenancy for transfer.

See also

Click https://docs.cloud.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 (*OrganizationClient) ConfigurationProvider 

func (client *OrganizationClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (OrganizationClient) CreateChildTenancy 

func (client OrganizationClient) CreateChildTenancy(ctx context.Context, request CreateChildTenancyRequest) (response CreateChildTenancyResponse, err error)

CreateChildTenancy Creates a child tenancy asynchronously.

See also

Click https://docs.cloud.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 (OrganizationClient) DeleteOrganizationTenancy 

func (client OrganizationClient) DeleteOrganizationTenancy(ctx context.Context, request DeleteOrganizationTenancyRequest) (response DeleteOrganizationTenancyResponse, err error)

DeleteOrganizationTenancy If certain validations are successful, initiate tenancy termination.

See also

Click https://docs.cloud.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 (OrganizationClient) GetOrganization 

func (client OrganizationClient) GetOrganization(ctx context.Context, request GetOrganizationRequest) (response GetOrganizationResponse, err error)

GetOrganization Gets information about the organization.

See also

Click https://docs.cloud.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 (OrganizationClient) GetOrganizationTenancy 

func (client OrganizationClient) GetOrganizationTenancy(ctx context.Context, request GetOrganizationTenancyRequest) (response GetOrganizationTenancyResponse, err error)

GetOrganizationTenancy Gets information about the organization's tenancy.

See also

Click https://docs.cloud.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 (OrganizationClient) ListOrganizationTenancies 

func (client OrganizationClient) ListOrganizationTenancies(ctx context.Context, request ListOrganizationTenanciesRequest) (response ListOrganizationTenanciesResponse, err error)

ListOrganizationTenancies Gets a list of tenancies in the organization.

See also

Click https://docs.cloud.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 (OrganizationClient) ListOrganizations 

func (client OrganizationClient) ListOrganizations(ctx context.Context, request ListOrganizationsRequest) (response ListOrganizationsResponse, err error)

ListOrganizations Lists organizations associated with the caller.

See also

Click https://docs.cloud.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 (OrganizationClient) RestoreOrganizationTenancy added in v65.3.0 

func (client OrganizationClient) RestoreOrganizationTenancy(ctx context.Context, request RestoreOrganizationTenancyRequest) (response RestoreOrganizationTenancyResponse, err error)

RestoreOrganizationTenancy An asynchronous API to restore a tenancy.

See also

Click https://docs.cloud.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 (*OrganizationClient) SetRegion 

func (client *OrganizationClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (OrganizationClient) UnapproveOrganizationTenancyForTransfer 

func (client OrganizationClient) UnapproveOrganizationTenancyForTransfer(ctx context.Context, request UnapproveOrganizationTenancyForTransferRequest) (response UnapproveOrganizationTenancyForTransferResponse, err error)

UnapproveOrganizationTenancyForTransfer Cancel an organization's child tenancy for transfer.

See also

Click https://docs.cloud.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 (OrganizationClient) UpdateOrganization 

func (client OrganizationClient) UpdateOrganization(ctx context.Context, request UpdateOrganizationRequest) (response UpdateOrganizationResponse, err error)

UpdateOrganization Map the default subscription to the organization.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/UpdateOrganization.go.html to see an example of how to use UpdateOrganization API.

type OrganizationCollection 

type OrganizationCollection struct {

	// Array containing OrganizationSummary items.
	Items []OrganizationSummary `mandatory:"true" json:"items"`
}

OrganizationCollection Result of a query request for a list of organizations. Contains OrganizationSummary items.

func (OrganizationCollection) String 

func (m OrganizationCollection) String() string

func (OrganizationCollection) ValidateEnumValue 

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

type OrganizationLifecycleStateEnum 

type OrganizationLifecycleStateEnum string

OrganizationLifecycleStateEnum Enum with underlying type: string 

const (
	OrganizationLifecycleStateCreating OrganizationLifecycleStateEnum = "CREATING"
	OrganizationLifecycleStateActive   OrganizationLifecycleStateEnum = "ACTIVE"
	OrganizationLifecycleStateUpdating OrganizationLifecycleStateEnum = "UPDATING"
	OrganizationLifecycleStateDeleting OrganizationLifecycleStateEnum = "DELETING"
	OrganizationLifecycleStateDeleted  OrganizationLifecycleStateEnum = "DELETED"
	OrganizationLifecycleStateFailed   OrganizationLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for OrganizationLifecycleStateEnum

func GetMappingOrganizationLifecycleStateEnum 

func GetMappingOrganizationLifecycleStateEnum(val string) (OrganizationLifecycleStateEnum, bool)

GetMappingOrganizationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOrganizationLifecycleStateEnumValues 

func GetOrganizationLifecycleStateEnumValues() []OrganizationLifecycleStateEnum

GetOrganizationLifecycleStateEnumValues Enumerates the set of values for OrganizationLifecycleStateEnum

type OrganizationSummary 

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"`
}

OrganizationSummary An organization entity.

func (OrganizationSummary) String 

func (m OrganizationSummary) String() string

func (OrganizationSummary) ValidateEnumValue 

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

type OrganizationTenancy 

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"`
}

OrganizationTenancy The information about the organization tenancy.

func (OrganizationTenancy) String 

func (m OrganizationTenancy) String() string

func (OrganizationTenancy) ValidateEnumValue 

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

type OrganizationTenancyCollection 

type OrganizationTenancyCollection struct {

	// Array containing OrganizationTenancySummary items.
	Items []OrganizationTenancySummary `mandatory:"true" json:"items"`
}

OrganizationTenancyCollection Result of a query request for a list of organization tenancies. Contains OrganizationTenancySummary items.

func (OrganizationTenancyCollection) String 

func (m OrganizationTenancyCollection) String() string

func (OrganizationTenancyCollection) ValidateEnumValue 

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

type OrganizationTenancyLifecycleStateEnum 

type OrganizationTenancyLifecycleStateEnum string

OrganizationTenancyLifecycleStateEnum Enum with underlying type: string 

const (
	OrganizationTenancyLifecycleStateCreating OrganizationTenancyLifecycleStateEnum = "CREATING"
	OrganizationTenancyLifecycleStateActive   OrganizationTenancyLifecycleStateEnum = "ACTIVE"
	OrganizationTenancyLifecycleStateInactive OrganizationTenancyLifecycleStateEnum = "INACTIVE"
	OrganizationTenancyLifecycleStateDeleted  OrganizationTenancyLifecycleStateEnum = "DELETED"
	OrganizationTenancyLifecycleStateFailed   OrganizationTenancyLifecycleStateEnum = "FAILED"
	OrganizationTenancyLifecycleStateDeleting OrganizationTenancyLifecycleStateEnum = "DELETING"
)

Set of constants representing the allowable values for OrganizationTenancyLifecycleStateEnum

func GetMappingOrganizationTenancyLifecycleStateEnum 

func GetMappingOrganizationTenancyLifecycleStateEnum(val string) (OrganizationTenancyLifecycleStateEnum, bool)

GetMappingOrganizationTenancyLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOrganizationTenancyLifecycleStateEnumValues 

func GetOrganizationTenancyLifecycleStateEnumValues() []OrganizationTenancyLifecycleStateEnum

GetOrganizationTenancyLifecycleStateEnumValues Enumerates the set of values for OrganizationTenancyLifecycleStateEnum

type OrganizationTenancyRoleEnum 

type OrganizationTenancyRoleEnum string

OrganizationTenancyRoleEnum Enum with underlying type: string 

const (
	OrganizationTenancyRoleParent OrganizationTenancyRoleEnum = "PARENT"
	OrganizationTenancyRoleChild  OrganizationTenancyRoleEnum = "CHILD"
	OrganizationTenancyRoleNone   OrganizationTenancyRoleEnum = "NONE"
)

Set of constants representing the allowable values for OrganizationTenancyRoleEnum

func GetMappingOrganizationTenancyRoleEnum 

func GetMappingOrganizationTenancyRoleEnum(val string) (OrganizationTenancyRoleEnum, bool)

GetMappingOrganizationTenancyRoleEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOrganizationTenancyRoleEnumValues 

func GetOrganizationTenancyRoleEnumValues() []OrganizationTenancyRoleEnum

GetOrganizationTenancyRoleEnumValues Enumerates the set of values for OrganizationTenancyRoleEnum

type OrganizationTenancySummary 

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"`
}

OrganizationTenancySummary An organization tenancy summary entity.

func (OrganizationTenancySummary) String 

func (m OrganizationTenancySummary) String() string

func (OrganizationTenancySummary) ValidateEnumValue 

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

type Promotion added in v65.11.0 

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"`
}

Promotion Promotion information for a subscription.

func (Promotion) String added in v65.11.0 

func (m Promotion) String() string

func (Promotion) ValidateEnumValue added in v65.11.0 

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

type PromotionStatusEnum added in v65.11.0 

type PromotionStatusEnum string

PromotionStatusEnum Enum with underlying type: string 

const (
	PromotionStatusInitialized PromotionStatusEnum = "INITIALIZED"
	PromotionStatusActive      PromotionStatusEnum = "ACTIVE"
	PromotionStatusExpired     PromotionStatusEnum = "EXPIRED"
)

Set of constants representing the allowable values for PromotionStatusEnum

func GetMappingPromotionStatusEnum added in v65.11.0 

func GetMappingPromotionStatusEnum(val string) (PromotionStatusEnum, bool)

GetMappingPromotionStatusEnum performs case Insensitive comparison on enum value and return the desired enum

func GetPromotionStatusEnumValues added in v65.11.0 

func GetPromotionStatusEnumValues() []PromotionStatusEnum

GetPromotionStatusEnumValues Enumerates the set of values for PromotionStatusEnum

type RecipientInvitation 

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"`
}

RecipientInvitation The invitation model that the recipient owns.

func (RecipientInvitation) String 

func (m RecipientInvitation) String() string

func (RecipientInvitation) ValidateEnumValue 

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

type RecipientInvitationClient 

type RecipientInvitationClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

RecipientInvitationClient a client for RecipientInvitation

func NewRecipientInvitationClientWithConfigurationProvider 

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 

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 (RecipientInvitationClient) AcceptRecipientInvitation 

func (client RecipientInvitationClient) AcceptRecipientInvitation(ctx context.Context, request AcceptRecipientInvitationRequest) (response AcceptRecipientInvitationResponse, err error)

AcceptRecipientInvitation Accepts a recipient invitation.

See also

Click https://docs.cloud.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 (*RecipientInvitationClient) ConfigurationProvider 

func (client *RecipientInvitationClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (RecipientInvitationClient) GetRecipientInvitation 

func (client RecipientInvitationClient) GetRecipientInvitation(ctx context.Context, request GetRecipientInvitationRequest) (response GetRecipientInvitationResponse, err error)

GetRecipientInvitation Gets information about the recipient invitation.

See also

Click https://docs.cloud.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 (RecipientInvitationClient) IgnoreRecipientInvitation 

func (client RecipientInvitationClient) IgnoreRecipientInvitation(ctx context.Context, request IgnoreRecipientInvitationRequest) (response IgnoreRecipientInvitationResponse, err error)

IgnoreRecipientInvitation Ignores a recipient invitation.

See also

Click https://docs.cloud.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 (RecipientInvitationClient) ListRecipientInvitations 

func (client RecipientInvitationClient) ListRecipientInvitations(ctx context.Context, request ListRecipientInvitationsRequest) (response ListRecipientInvitationsResponse, err error)

ListRecipientInvitations Return a (paginated) list of recipient invitations.

See also

Click https://docs.cloud.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 (*RecipientInvitationClient) SetRegion 

func (client *RecipientInvitationClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (RecipientInvitationClient) UpdateRecipientInvitation 

func (client RecipientInvitationClient) UpdateRecipientInvitation(ctx context.Context, request UpdateRecipientInvitationRequest) (response UpdateRecipientInvitationResponse, err error)

UpdateRecipientInvitation Updates the recipient invitation.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/UpdateRecipientInvitation.go.html to see an example of how to use UpdateRecipientInvitation API.

type RecipientInvitationCollection 

type RecipientInvitationCollection struct {

	// Array containing RecipientInvitationSummary items.
	Items []RecipientInvitationSummary `mandatory:"true" json:"items"`
}

RecipientInvitationCollection Result of a query request for a list of recipient invitations. Contains RecipientInvitationSummary items.

func (RecipientInvitationCollection) String 

func (m RecipientInvitationCollection) String() string

func (RecipientInvitationCollection) ValidateEnumValue 

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

type RecipientInvitationStatusEnum 

type RecipientInvitationStatusEnum string

RecipientInvitationStatusEnum Enum with underlying type: string 

const (
	RecipientInvitationStatusPending  RecipientInvitationStatusEnum = "PENDING"
	RecipientInvitationStatusCanceled RecipientInvitationStatusEnum = "CANCELED"
	RecipientInvitationStatusAccepted RecipientInvitationStatusEnum = "ACCEPTED"
	RecipientInvitationStatusIgnored  RecipientInvitationStatusEnum = "IGNORED"
	RecipientInvitationStatusExpired  RecipientInvitationStatusEnum = "EXPIRED"
	RecipientInvitationStatusFailed   RecipientInvitationStatusEnum = "FAILED"
)

Set of constants representing the allowable values for RecipientInvitationStatusEnum

func GetMappingRecipientInvitationStatusEnum 

func GetMappingRecipientInvitationStatusEnum(val string) (RecipientInvitationStatusEnum, bool)

GetMappingRecipientInvitationStatusEnum performs case Insensitive comparison on enum value and return the desired enum

func GetRecipientInvitationStatusEnumValues 

func GetRecipientInvitationStatusEnumValues() []RecipientInvitationStatusEnum

GetRecipientInvitationStatusEnumValues Enumerates the set of values for RecipientInvitationStatusEnum

type RecipientInvitationSummary 

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"`
}

RecipientInvitationSummary The summary of the invitation model that the recipient owns.

func (RecipientInvitationSummary) String 

func (m RecipientInvitationSummary) String() string

func (RecipientInvitationSummary) ValidateEnumValue 

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

type RemoveGovernanceRequest added in v65.36.1 

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
}

RemoveGovernanceRequest wrapper for the RemoveGovernance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/RemoveGovernance.go.html to see an example of how to use RemoveGovernanceRequest.

func (RemoveGovernanceRequest) BinaryRequestBody added in v65.36.1 

func (request RemoveGovernanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (RemoveGovernanceRequest) HTTPRequest added in v65.36.1 

func (request RemoveGovernanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RemoveGovernanceRequest) RetryPolicy added in v65.36.1 

func (request RemoveGovernanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (RemoveGovernanceRequest) String added in v65.36.1 

func (request RemoveGovernanceRequest) String() string

func (RemoveGovernanceRequest) ValidateEnumValue added in v65.36.1 

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

type RemoveGovernanceResponse added in v65.36.1 

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"`
}

RemoveGovernanceResponse wrapper for the RemoveGovernance operation

func (RemoveGovernanceResponse) HTTPResponse added in v65.36.1 

func (response RemoveGovernanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (RemoveGovernanceResponse) String added in v65.36.1 

func (response RemoveGovernanceResponse) String() string

type RestoreOrganizationTenancyRequest added in v65.3.0 

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
}

RestoreOrganizationTenancyRequest wrapper for the RestoreOrganizationTenancy operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/RestoreOrganizationTenancy.go.html to see an example of how to use RestoreOrganizationTenancyRequest.

func (RestoreOrganizationTenancyRequest) BinaryRequestBody added in v65.3.0 

func (request RestoreOrganizationTenancyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (RestoreOrganizationTenancyRequest) HTTPRequest added in v65.3.0 

func (request RestoreOrganizationTenancyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RestoreOrganizationTenancyRequest) RetryPolicy added in v65.3.0 

func (request RestoreOrganizationTenancyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (RestoreOrganizationTenancyRequest) String added in v65.3.0 

func (request RestoreOrganizationTenancyRequest) String() string

func (RestoreOrganizationTenancyRequest) ValidateEnumValue added in v65.3.0 

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

type RestoreOrganizationTenancyResponse added in v65.3.0 

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"`
}

RestoreOrganizationTenancyResponse wrapper for the RestoreOrganizationTenancy operation

func (RestoreOrganizationTenancyResponse) HTTPResponse added in v65.3.0 

func (response RestoreOrganizationTenancyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (RestoreOrganizationTenancyResponse) String added in v65.3.0 

func (response RestoreOrganizationTenancyResponse) String() string

type ReviveWorkflowInstanceDetails added in v65.45.0 

type ReviveWorkflowInstanceDetails struct {

	// Id of failed workflow
	WorkflowInstanceId *string `mandatory:"false" json:"workflowInstanceId"`

	// Service specific workflow instance name
	WorkflowInstanceName *string `mandatory:"false" json:"workflowInstanceName"`
}

ReviveWorkflowInstanceDetails The parameters for reviving failed workflow

func (ReviveWorkflowInstanceDetails) String added in v65.45.0 

func (m ReviveWorkflowInstanceDetails) String() string

func (ReviveWorkflowInstanceDetails) ValidateEnumValue added in v65.45.0 

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

type SenderInvitation 

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"`
}

SenderInvitation The invitation model that the sender owns.

func (SenderInvitation) String 

func (m SenderInvitation) String() string

func (SenderInvitation) ValidateEnumValue 

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

type SenderInvitationClient 

type SenderInvitationClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

SenderInvitationClient a client for SenderInvitation

func NewSenderInvitationClientWithConfigurationProvider 

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 

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 (SenderInvitationClient) CancelSenderInvitation 

func (client SenderInvitationClient) CancelSenderInvitation(ctx context.Context, request CancelSenderInvitationRequest) (response CancelSenderInvitationResponse, err error)

CancelSenderInvitation Cancels a sender invitation.

See also

Click https://docs.cloud.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 (*SenderInvitationClient) ConfigurationProvider 

func (client *SenderInvitationClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (SenderInvitationClient) CreateSenderInvitation 

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.

See also

Click https://docs.cloud.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 (SenderInvitationClient) GetSenderInvitation 

func (client SenderInvitationClient) GetSenderInvitation(ctx context.Context, request GetSenderInvitationRequest) (response GetSenderInvitationResponse, err error)

GetSenderInvitation Gets information about the sender invitation.

See also

Click https://docs.cloud.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 (SenderInvitationClient) ListSenderInvitations 

func (client SenderInvitationClient) ListSenderInvitations(ctx context.Context, request ListSenderInvitationsRequest) (response ListSenderInvitationsResponse, err error)

ListSenderInvitations Return a (paginated) list of sender invitations.

See also

Click https://docs.cloud.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 (*SenderInvitationClient) SetRegion 

func (client *SenderInvitationClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (SenderInvitationClient) UpdateSenderInvitation 

func (client SenderInvitationClient) UpdateSenderInvitation(ctx context.Context, request UpdateSenderInvitationRequest) (response UpdateSenderInvitationResponse, err error)

UpdateSenderInvitation Updates the sender invitation.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/UpdateSenderInvitation.go.html to see an example of how to use UpdateSenderInvitation API.

type SenderInvitationCollection 

type SenderInvitationCollection struct {

	// Array containing SenderInvitationSummary items.
	Items []SenderInvitationSummary `mandatory:"true" json:"items"`
}

SenderInvitationCollection Result of a query request for a list of sender invitations. Contains SenderInvitationSummary items.

func (SenderInvitationCollection) String 

func (m SenderInvitationCollection) String() string

func (SenderInvitationCollection) ValidateEnumValue 

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

type SenderInvitationStatusEnum 

type SenderInvitationStatusEnum string

SenderInvitationStatusEnum Enum with underlying type: string 

const (
	SenderInvitationStatusPending  SenderInvitationStatusEnum = "PENDING"
	SenderInvitationStatusCanceled SenderInvitationStatusEnum = "CANCELED"
	SenderInvitationStatusAccepted SenderInvitationStatusEnum = "ACCEPTED"
	SenderInvitationStatusExpired  SenderInvitationStatusEnum = "EXPIRED"
	SenderInvitationStatusFailed   SenderInvitationStatusEnum = "FAILED"
)

Set of constants representing the allowable values for SenderInvitationStatusEnum

func GetMappingSenderInvitationStatusEnum 

func GetMappingSenderInvitationStatusEnum(val string) (SenderInvitationStatusEnum, bool)

GetMappingSenderInvitationStatusEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSenderInvitationStatusEnumValues 

func GetSenderInvitationStatusEnumValues() []SenderInvitationStatusEnum

GetSenderInvitationStatusEnumValues Enumerates the set of values for SenderInvitationStatusEnum

type SenderInvitationSummary 

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"`
}

SenderInvitationSummary The summary of the invitation model that the sender owns.

func (SenderInvitationSummary) String 

func (m SenderInvitationSummary) String() string

func (SenderInvitationSummary) ValidateEnumValue 

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

type 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"`
}

Sku A single subscription SKU.

func (Sku) String 

func (m Sku) String() string

func (Sku) ValidateEnumValue 

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

type SortOrderEnum 

type SortOrderEnum string

SortOrderEnum Enum with underlying type: string 

const (
	SortOrderAsc  SortOrderEnum = "ASC"
	SortOrderDesc SortOrderEnum = "DESC"
)

Set of constants representing the allowable values for SortOrderEnum

func GetMappingSortOrderEnum 

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSortOrderEnumValues 

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type Subscription 

type Subscription interface {

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the subscription.
	GetId() *string

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/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{}
}

Subscription Base subscription type, which carries shared properties for any subscription version.

type SubscriptionClient 

type SubscriptionClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

SubscriptionClient a client for Subscription

func NewSubscriptionClientWithConfigurationProvider 

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 

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 (*SubscriptionClient) ConfigurationProvider 

func (client *SubscriptionClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (SubscriptionClient) CreateSubscriptionMapping 

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.

See also

Click https://docs.cloud.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 (SubscriptionClient) DeleteSubscriptionMapping 

func (client SubscriptionClient) DeleteSubscriptionMapping(ctx context.Context, request DeleteSubscriptionMappingRequest) (response DeleteSubscriptionMappingResponse, err error)

DeleteSubscriptionMapping Delete the subscription mapping details by subscription mapping ID.

See also

Click https://docs.cloud.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 (SubscriptionClient) GetAssignedSubscription 

func (client SubscriptionClient) GetAssignedSubscription(ctx context.Context, request GetAssignedSubscriptionRequest) (response GetAssignedSubscriptionResponse, err error)

GetAssignedSubscription Get the assigned subscription details by assigned subscription ID.

See also

Click https://docs.cloud.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 (SubscriptionClient) GetSubscription 

func (client SubscriptionClient) GetSubscription(ctx context.Context, request GetSubscriptionRequest) (response GetSubscriptionResponse, err error)

GetSubscription Gets the subscription details by subscription ID.

See also

Click https://docs.cloud.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 (SubscriptionClient) GetSubscriptionMapping 

func (client SubscriptionClient) GetSubscriptionMapping(ctx context.Context, request GetSubscriptionMappingRequest) (response GetSubscriptionMappingResponse, err error)

GetSubscriptionMapping Get the subscription mapping details by subscription mapping ID.

See also

Click https://docs.cloud.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 (SubscriptionClient) ListAssignedSubscriptionLineItems added in v65.45.0 

func (client SubscriptionClient) ListAssignedSubscriptionLineItems(ctx context.Context, request ListAssignedSubscriptionLineItemsRequest) (response ListAssignedSubscriptionLineItemsResponse, err error)

ListAssignedSubscriptionLineItems List line item summaries that a assigned subscription owns.

See also

Click https://docs.cloud.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 (SubscriptionClient) ListAssignedSubscriptions 

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.

See also

Click https://docs.cloud.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 (SubscriptionClient) ListAvailableRegions 

func (client SubscriptionClient) ListAvailableRegions(ctx context.Context, request ListAvailableRegionsRequest) (response ListAvailableRegionsResponse, err error)

ListAvailableRegions List the available regions based on subscription ID.

See also

Click https://docs.cloud.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 (SubscriptionClient) ListSubscriptionLineItems added in v65.45.0 

func (client SubscriptionClient) ListSubscriptionLineItems(ctx context.Context, request ListSubscriptionLineItemsRequest) (response ListSubscriptionLineItemsResponse, err error)

ListSubscriptionLineItems Lists the line items in a subscription.

See also

Click https://docs.cloud.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 (SubscriptionClient) ListSubscriptionMappings 

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.

See also

Click https://docs.cloud.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 (SubscriptionClient) ListSubscriptions 

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.

See also

Click https://docs.cloud.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 (*SubscriptionClient) SetRegion 

func (client *SubscriptionClient) SetRegion(region string)

SetRegion overrides the region of this client.

type SubscriptionCollection 

type SubscriptionCollection struct {

	// Array containing subscription summary items.
	Items []SubscriptionSummary `mandatory:"true" json:"items"`
}

SubscriptionCollection List of subscription summaries.

func (SubscriptionCollection) String 

func (m SubscriptionCollection) String() string

func (*SubscriptionCollection) UnmarshalJSON added in v65.45.0 

func (m *SubscriptionCollection) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (SubscriptionCollection) ValidateEnumValue 

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

type SubscriptionEntityVersionEnum added in v65.45.0 

type SubscriptionEntityVersionEnum string

SubscriptionEntityVersionEnum Enum with underlying type: string 

const (
	SubscriptionEntityVersionV1 SubscriptionEntityVersionEnum = "V1"
	SubscriptionEntityVersionV2 SubscriptionEntityVersionEnum = "V2"
)

Set of constants representing the allowable values for SubscriptionEntityVersionEnum

func GetMappingSubscriptionEntityVersionEnum added in v65.45.0 

func GetMappingSubscriptionEntityVersionEnum(val string) (SubscriptionEntityVersionEnum, bool)

GetMappingSubscriptionEntityVersionEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSubscriptionEntityVersionEnumValues added in v65.45.0 

func GetSubscriptionEntityVersionEnumValues() []SubscriptionEntityVersionEnum

GetSubscriptionEntityVersionEnumValues Enumerates the set of values for SubscriptionEntityVersionEnum

type SubscriptionInfo 

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"`
}

SubscriptionInfo A single subscription's details.

func (SubscriptionInfo) String 

func (m SubscriptionInfo) String() string

func (SubscriptionInfo) ValidateEnumValue 

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

type SubscriptionLifecycleStateEnum 

type SubscriptionLifecycleStateEnum string

SubscriptionLifecycleStateEnum Enum with underlying type: string 

const (
	SubscriptionLifecycleStateNeedsAttention SubscriptionLifecycleStateEnum = "NEEDS_ATTENTION"
	SubscriptionLifecycleStateActive         SubscriptionLifecycleStateEnum = "ACTIVE"
	SubscriptionLifecycleStateInactive       SubscriptionLifecycleStateEnum = "INACTIVE"
	SubscriptionLifecycleStateFailed         SubscriptionLifecycleStateEnum = "FAILED"
	SubscriptionLifecycleStateCreating       SubscriptionLifecycleStateEnum = "CREATING"
)

Set of constants representing the allowable values for SubscriptionLifecycleStateEnum

func GetMappingSubscriptionLifecycleStateEnum 

func GetMappingSubscriptionLifecycleStateEnum(val string) (SubscriptionLifecycleStateEnum, bool)

GetMappingSubscriptionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSubscriptionLifecycleStateEnumValues 

func GetSubscriptionLifecycleStateEnumValues() []SubscriptionLifecycleStateEnum

GetSubscriptionLifecycleStateEnumValues Enumerates the set of values for SubscriptionLifecycleStateEnum

type SubscriptionLineItemCollection added in v65.45.0 

type SubscriptionLineItemCollection struct {

	// Array containing line item summaries in a subscription.
	Items []SubscriptionLineItemSummary `mandatory:"true" json:"items"`
}

SubscriptionLineItemCollection Collection of line item summaries in a subscription.

func (SubscriptionLineItemCollection) String added in v65.45.0 

func (m SubscriptionLineItemCollection) String() string

func (SubscriptionLineItemCollection) ValidateEnumValue added in v65.45.0 

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

type SubscriptionLineItemSummary added in v65.45.0 

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"`
}

SubscriptionLineItemSummary Summary of line items in a subscription.

func (SubscriptionLineItemSummary) String added in v65.45.0 

func (m SubscriptionLineItemSummary) String() string

func (SubscriptionLineItemSummary) ValidateEnumValue added in v65.45.0 

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

type SubscriptionMapping 

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"`
}

SubscriptionMapping Subscription mapping information.

func (SubscriptionMapping) String 

func (m SubscriptionMapping) String() string

func (SubscriptionMapping) ValidateEnumValue 

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

type SubscriptionMappingCollection 

type SubscriptionMappingCollection struct {

	// Array containing subscription mapping items.
	Items []SubscriptionMappingSummary `mandatory:"true" json:"items"`
}

SubscriptionMappingCollection List of subscription mappings.

func (SubscriptionMappingCollection) String 

func (m SubscriptionMappingCollection) String() string

func (SubscriptionMappingCollection) ValidateEnumValue 

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

type SubscriptionMappingLifecycleStateEnum 

type SubscriptionMappingLifecycleStateEnum string

SubscriptionMappingLifecycleStateEnum Enum with underlying type: string 

const (
	SubscriptionMappingLifecycleStateCreating SubscriptionMappingLifecycleStateEnum = "CREATING"
	SubscriptionMappingLifecycleStateActive   SubscriptionMappingLifecycleStateEnum = "ACTIVE"
	SubscriptionMappingLifecycleStateInactive SubscriptionMappingLifecycleStateEnum = "INACTIVE"
	SubscriptionMappingLifecycleStateUpdating SubscriptionMappingLifecycleStateEnum = "UPDATING"
	SubscriptionMappingLifecycleStateDeleting SubscriptionMappingLifecycleStateEnum = "DELETING"
	SubscriptionMappingLifecycleStateDeleted  SubscriptionMappingLifecycleStateEnum = "DELETED"
	SubscriptionMappingLifecycleStateFailed   SubscriptionMappingLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for SubscriptionMappingLifecycleStateEnum

func GetMappingSubscriptionMappingLifecycleStateEnum 

func GetMappingSubscriptionMappingLifecycleStateEnum(val string) (SubscriptionMappingLifecycleStateEnum, bool)

GetMappingSubscriptionMappingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSubscriptionMappingLifecycleStateEnumValues 

func GetSubscriptionMappingLifecycleStateEnumValues() []SubscriptionMappingLifecycleStateEnum

GetSubscriptionMappingLifecycleStateEnumValues Enumerates the set of values for SubscriptionMappingLifecycleStateEnum

type SubscriptionMappingSummary 

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"`
}

SubscriptionMappingSummary Subscription mapping information.

func (SubscriptionMappingSummary) String 

func (m SubscriptionMappingSummary) String() string

func (SubscriptionMappingSummary) ValidateEnumValue 

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

type SubscriptionSku 

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"`
}

SubscriptionSku SKU information.

func (SubscriptionSku) String 

func (m SubscriptionSku) String() string

func (SubscriptionSku) ValidateEnumValue 

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

type SubscriptionSummary 

type SubscriptionSummary interface {

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)) of the subscription.
	GetId() *string

	// The Oracle ID (OCID (https://docs.cloud.oracle.com/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{}
}

SubscriptionSummary Base subscription summary type, which carries shared properties for any subscription summary version.

type SubscriptionSummaryEntityVersionEnum added in v65.45.0 

type SubscriptionSummaryEntityVersionEnum string

SubscriptionSummaryEntityVersionEnum Enum with underlying type: string 

const (
	SubscriptionSummaryEntityVersionV1 SubscriptionSummaryEntityVersionEnum = "V1"
	SubscriptionSummaryEntityVersionV2 SubscriptionSummaryEntityVersionEnum = "V2"
)

Set of constants representing the allowable values for SubscriptionSummaryEntityVersionEnum

func GetMappingSubscriptionSummaryEntityVersionEnum added in v65.45.0 

func GetMappingSubscriptionSummaryEntityVersionEnum(val string) (SubscriptionSummaryEntityVersionEnum, bool)

GetMappingSubscriptionSummaryEntityVersionEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSubscriptionSummaryEntityVersionEnumValues added in v65.45.0 

func GetSubscriptionSummaryEntityVersionEnumValues() []SubscriptionSummaryEntityVersionEnum

GetSubscriptionSummaryEntityVersionEnumValues Enumerates the set of values for SubscriptionSummaryEntityVersionEnum

type 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
}

UnapproveOrganizationTenancyForTransferRequest wrapper for the UnapproveOrganizationTenancyForTransfer operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/UnapproveOrganizationTenancyForTransfer.go.html to see an example of how to use UnapproveOrganizationTenancyForTransferRequest.

func (UnapproveOrganizationTenancyForTransferRequest) BinaryRequestBody 

func (request UnapproveOrganizationTenancyForTransferRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UnapproveOrganizationTenancyForTransferRequest) HTTPRequest 

func (request UnapproveOrganizationTenancyForTransferRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UnapproveOrganizationTenancyForTransferRequest) RetryPolicy 

func (request UnapproveOrganizationTenancyForTransferRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UnapproveOrganizationTenancyForTransferRequest) String 

func (request UnapproveOrganizationTenancyForTransferRequest) String() string

func (UnapproveOrganizationTenancyForTransferRequest) ValidateEnumValue 

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

type UnapproveOrganizationTenancyForTransferResponse 

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"`
}

UnapproveOrganizationTenancyForTransferResponse wrapper for the UnapproveOrganizationTenancyForTransfer operation

func (UnapproveOrganizationTenancyForTransferResponse) HTTPResponse 

func (response UnapproveOrganizationTenancyForTransferResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UnapproveOrganizationTenancyForTransferResponse) String 

func (response UnapproveOrganizationTenancyForTransferResponse) String() string

type UpdateDomainDetails 

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"`
}

UpdateDomainDetails The parameters for updating a domain.

func (UpdateDomainDetails) String 

func (m UpdateDomainDetails) String() string

func (UpdateDomainDetails) ValidateEnumValue 

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

type UpdateDomainGovernanceDetails 

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"`
}

UpdateDomainGovernanceDetails The parameters for updating a domain govenance entity.

func (UpdateDomainGovernanceDetails) String 

func (m UpdateDomainGovernanceDetails) String() string

func (UpdateDomainGovernanceDetails) ValidateEnumValue 

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

type 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
}

UpdateDomainGovernanceRequest wrapper for the UpdateDomainGovernance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/UpdateDomainGovernance.go.html to see an example of how to use UpdateDomainGovernanceRequest.

func (UpdateDomainGovernanceRequest) BinaryRequestBody 

func (request UpdateDomainGovernanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateDomainGovernanceRequest) HTTPRequest 

func (request UpdateDomainGovernanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateDomainGovernanceRequest) RetryPolicy 

func (request UpdateDomainGovernanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateDomainGovernanceRequest) String 

func (request UpdateDomainGovernanceRequest) String() string

func (UpdateDomainGovernanceRequest) ValidateEnumValue 

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

type UpdateDomainGovernanceResponse 

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"`
}

UpdateDomainGovernanceResponse wrapper for the UpdateDomainGovernance operation

func (UpdateDomainGovernanceResponse) HTTPResponse 

func (response UpdateDomainGovernanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateDomainGovernanceResponse) String 

func (response UpdateDomainGovernanceResponse) String() string

type 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
}

UpdateDomainRequest wrapper for the UpdateDomain operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/UpdateDomain.go.html to see an example of how to use UpdateDomainRequest.

func (UpdateDomainRequest) BinaryRequestBody 

func (request UpdateDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateDomainRequest) HTTPRequest 

func (request UpdateDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateDomainRequest) RetryPolicy 

func (request UpdateDomainRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateDomainRequest) String 

func (request UpdateDomainRequest) String() string

func (UpdateDomainRequest) ValidateEnumValue 

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

type UpdateDomainResponse 

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"`
}

UpdateDomainResponse wrapper for the UpdateDomain operation

func (UpdateDomainResponse) HTTPResponse 

func (response UpdateDomainResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateDomainResponse) String 

func (response UpdateDomainResponse) String() string

type UpdateOrganizationDetails 

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"`
}

UpdateOrganizationDetails The parameters for updating an organization.

func (UpdateOrganizationDetails) String 

func (m UpdateOrganizationDetails) String() string

func (UpdateOrganizationDetails) ValidateEnumValue 

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

type 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
}

UpdateOrganizationRequest wrapper for the UpdateOrganization operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/UpdateOrganization.go.html to see an example of how to use UpdateOrganizationRequest.

func (UpdateOrganizationRequest) BinaryRequestBody 

func (request UpdateOrganizationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateOrganizationRequest) HTTPRequest 

func (request UpdateOrganizationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateOrganizationRequest) RetryPolicy 

func (request UpdateOrganizationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateOrganizationRequest) String 

func (request UpdateOrganizationRequest) String() string

func (UpdateOrganizationRequest) ValidateEnumValue 

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

type UpdateOrganizationResponse 

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"`
}

UpdateOrganizationResponse wrapper for the UpdateOrganization operation

func (UpdateOrganizationResponse) HTTPResponse 

func (response UpdateOrganizationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateOrganizationResponse) String 

func (response UpdateOrganizationResponse) String() string

type UpdateRecipientInvitationDetails 

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"`
}

UpdateRecipientInvitationDetails The parameters for updating a recipient invitation.

func (UpdateRecipientInvitationDetails) String 

func (m UpdateRecipientInvitationDetails) String() string

func (UpdateRecipientInvitationDetails) ValidateEnumValue 

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

type 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
}

UpdateRecipientInvitationRequest wrapper for the UpdateRecipientInvitation operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/UpdateRecipientInvitation.go.html to see an example of how to use UpdateRecipientInvitationRequest.

func (UpdateRecipientInvitationRequest) BinaryRequestBody 

func (request UpdateRecipientInvitationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateRecipientInvitationRequest) HTTPRequest 

func (request UpdateRecipientInvitationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateRecipientInvitationRequest) RetryPolicy 

func (request UpdateRecipientInvitationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateRecipientInvitationRequest) String 

func (request UpdateRecipientInvitationRequest) String() string

func (UpdateRecipientInvitationRequest) ValidateEnumValue 

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

type UpdateRecipientInvitationResponse 

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"`
}

UpdateRecipientInvitationResponse wrapper for the UpdateRecipientInvitation operation

func (UpdateRecipientInvitationResponse) HTTPResponse 

func (response UpdateRecipientInvitationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateRecipientInvitationResponse) String 

func (response UpdateRecipientInvitationResponse) String() string

type UpdateSenderInvitationDetails 

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"`
}

UpdateSenderInvitationDetails The parameters for updating a sender invitation.

func (UpdateSenderInvitationDetails) String 

func (m UpdateSenderInvitationDetails) String() string

func (UpdateSenderInvitationDetails) ValidateEnumValue 

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

type 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
}

UpdateSenderInvitationRequest wrapper for the UpdateSenderInvitation operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/UpdateSenderInvitation.go.html to see an example of how to use UpdateSenderInvitationRequest.

func (UpdateSenderInvitationRequest) BinaryRequestBody 

func (request UpdateSenderInvitationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateSenderInvitationRequest) HTTPRequest 

func (request UpdateSenderInvitationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateSenderInvitationRequest) RetryPolicy 

func (request UpdateSenderInvitationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateSenderInvitationRequest) String 

func (request UpdateSenderInvitationRequest) String() string

func (UpdateSenderInvitationRequest) ValidateEnumValue 

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

type UpdateSenderInvitationResponse 

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"`
}

UpdateSenderInvitationResponse wrapper for the UpdateSenderInvitation operation

func (UpdateSenderInvitationResponse) HTTPResponse 

func (response UpdateSenderInvitationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateSenderInvitationResponse) String 

func (response UpdateSenderInvitationResponse) String() string

type WorkRequest 

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"`
}

WorkRequest A description of the work request status.

func (WorkRequest) String 

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue 

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

type WorkRequestClient 

type WorkRequestClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

WorkRequestClient a client for WorkRequest

func NewWorkRequestClientWithConfigurationProvider 

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 

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 (*WorkRequestClient) ConfigurationProvider 

func (client *WorkRequestClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (WorkRequestClient) GetWorkRequest 

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.

See also

Click https://docs.cloud.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 (WorkRequestClient) ListWorkRequestErrors 

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.

See also

Click https://docs.cloud.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 (WorkRequestClient) ListWorkRequestLogs 

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.

See also

Click https://docs.cloud.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 (WorkRequestClient) ListWorkRequests 

func (client WorkRequestClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)

ListWorkRequests Lists the work requests in a compartment.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/tenantmanagercontrolplane/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API.

func (*WorkRequestClient) SetRegion 

func (client *WorkRequestClient) SetRegion(region string)

SetRegion overrides the region of this client.

type WorkRequestCollection 

type WorkRequestCollection struct {

	// Array containing WorkRequestSummary items.
	Items []WorkRequestSummary `mandatory:"true" json:"items"`
}

WorkRequestCollection Result of a query request for a list of work requests. Contains WorkRequestSummary items.

func (WorkRequestCollection) String 

func (m WorkRequestCollection) String() string

func (WorkRequestCollection) ValidateEnumValue 

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

type WorkRequestError 

type WorkRequestError struct {

	// A machine-usable code for the error that occured. Error codes are listed in
	// API Errors (https://docs.cloud.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"`
}

WorkRequestError An error encountered while executing a work request.

func (WorkRequestError) String 

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue 

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

type WorkRequestErrorCollection 

type WorkRequestErrorCollection struct {

	// Array containing WorkRequestError items.
	Items []WorkRequestError `mandatory:"true" json:"items"`
}

WorkRequestErrorCollection Result of a query request for a list of work request errors. Contains WorkRequestError items.

func (WorkRequestErrorCollection) String 

func (m WorkRequestErrorCollection) String() string

func (WorkRequestErrorCollection) ValidateEnumValue 

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

type WorkRequestLogEntry 

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"`
}

WorkRequestLogEntry A log message from the execution of a work request.

func (WorkRequestLogEntry) String 

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue 

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

type WorkRequestLogEntryCollection 

type WorkRequestLogEntryCollection struct {

	// Array containing WorkRequestLogEntry items.
	Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}

WorkRequestLogEntryCollection Result of a query request for a list of work request log entries. Contains WorkRequestLogEntry items.

func (WorkRequestLogEntryCollection) String 

func (m WorkRequestLogEntryCollection) String() string

func (WorkRequestLogEntryCollection) ValidateEnumValue 

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

type WorkRequestResource 

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"`
}

WorkRequestResource A resource created or operated on by a work request.

func (WorkRequestResource) String 

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue 

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

type WorkRequestSummary 

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"`
}

WorkRequestSummary A summary of work request status.

func (WorkRequestSummary) String 

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.