Documentation ¶
Index ¶
- type AcceptRecipientInvitationRequest
- type AcceptRecipientInvitationResponse
- type ActionTypeEnum
- type CancelSenderInvitationRequest
- type CancelSenderInvitationResponse
- type CreateDomainDetails
- type CreateDomainGovernanceDetails
- type CreateDomainGovernanceRequest
- type CreateDomainGovernanceResponse
- type CreateDomainRequest
- type CreateDomainResponse
- type CreateSenderInvitationDetails
- type CreateSenderInvitationRequest
- type CreateSenderInvitationResponse
- type DeleteDomainGovernanceRequest
- type DeleteDomainGovernanceResponse
- type DeleteDomainRequest
- type DeleteDomainResponse
- type DeleteLinkRequest
- type DeleteLinkResponse
- type Domain
- type DomainClient
- func (client *DomainClient) ConfigurationProvider() *common.ConfigurationProvider
- func (client DomainClient) CreateDomain(ctx context.Context, request CreateDomainRequest) (response CreateDomainResponse, err error)
- func (client DomainClient) DeleteDomain(ctx context.Context, request DeleteDomainRequest) (response DeleteDomainResponse, err error)
- func (client DomainClient) GetDomain(ctx context.Context, request GetDomainRequest) (response GetDomainResponse, err error)
- func (client DomainClient) ListDomains(ctx context.Context, request ListDomainsRequest) (response ListDomainsResponse, err error)
- func (client *DomainClient) SetRegion(region string)
- func (client DomainClient) UpdateDomain(ctx context.Context, request UpdateDomainRequest) (response UpdateDomainResponse, err error)
- type DomainCollection
- type DomainGovernance
- type DomainGovernanceClient
- func (client *DomainGovernanceClient) ConfigurationProvider() *common.ConfigurationProvider
- func (client DomainGovernanceClient) CreateDomainGovernance(ctx context.Context, request CreateDomainGovernanceRequest) (response CreateDomainGovernanceResponse, err error)
- func (client DomainGovernanceClient) DeleteDomainGovernance(ctx context.Context, request DeleteDomainGovernanceRequest) (response DeleteDomainGovernanceResponse, err error)
- func (client DomainGovernanceClient) GetDomainGovernance(ctx context.Context, request GetDomainGovernanceRequest) (response GetDomainGovernanceResponse, err error)
- func (client DomainGovernanceClient) ListDomainGovernances(ctx context.Context, request ListDomainGovernancesRequest) (response ListDomainGovernancesResponse, err error)
- func (client *DomainGovernanceClient) SetRegion(region string)
- func (client DomainGovernanceClient) UpdateDomainGovernance(ctx context.Context, request UpdateDomainGovernanceRequest) (response UpdateDomainGovernanceResponse, err error)
- type DomainGovernanceCollection
- type DomainGovernanceLifecycleStateEnum
- type DomainGovernanceSummary
- type DomainLifecycleStateEnum
- type DomainStatusEnum
- type DomainSummary
- type GetDomainGovernanceRequest
- type GetDomainGovernanceResponse
- type GetDomainRequest
- type GetDomainResponse
- type GetLinkRequest
- type GetLinkResponse
- type GetRecipientInvitationRequest
- type GetRecipientInvitationResponse
- type GetSenderInvitationRequest
- type GetSenderInvitationResponse
- type GetWorkRequestRequest
- type GetWorkRequestResponse
- type IgnoreRecipientInvitationRequest
- type IgnoreRecipientInvitationResponse
- type LifecycleStateEnum
- type Link
- type LinkClient
- func (client *LinkClient) ConfigurationProvider() *common.ConfigurationProvider
- func (client LinkClient) DeleteLink(ctx context.Context, request DeleteLinkRequest) (response DeleteLinkResponse, err error)
- func (client LinkClient) GetLink(ctx context.Context, request GetLinkRequest) (response GetLinkResponse, err error)
- func (client LinkClient) ListLinks(ctx context.Context, request ListLinksRequest) (response ListLinksResponse, err error)
- func (client *LinkClient) SetRegion(region string)
- type LinkCollection
- type LinkSummary
- type ListDomainGovernancesLifecycleStateEnum
- type ListDomainGovernancesRequest
- type ListDomainGovernancesResponse
- type ListDomainGovernancesSortByEnum
- type ListDomainGovernancesSortOrderEnum
- type ListDomainsLifecycleStateEnum
- type ListDomainsRequest
- type ListDomainsResponse
- type ListDomainsSortByEnum
- type ListDomainsSortOrderEnum
- type ListLinksLifecycleStateEnum
- type ListLinksRequest
- type ListLinksResponse
- type ListLinksSortOrderEnum
- type ListRecipientInvitationsLifecycleStateEnum
- type ListRecipientInvitationsRequest
- type ListRecipientInvitationsResponse
- type ListRecipientInvitationsStatusEnum
- type ListSenderInvitationsLifecycleStateEnum
- type ListSenderInvitationsRequest
- type ListSenderInvitationsResponse
- type ListSenderInvitationsSortByEnum
- type ListSenderInvitationsSortOrderEnum
- type ListSenderInvitationsStatusEnum
- type ListWorkRequestErrorsRequest
- type ListWorkRequestErrorsResponse
- type ListWorkRequestErrorsSortOrderEnum
- type ListWorkRequestLogsRequest
- type ListWorkRequestLogsResponse
- type ListWorkRequestLogsSortOrderEnum
- type ListWorkRequestsRequest
- type ListWorkRequestsResponse
- type ListWorkRequestsSortOrderEnum
- type OperationStatusEnum
- type OperationTypeEnum
- type RecipientInvitation
- type RecipientInvitationClient
- func NewRecipientInvitationClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client RecipientInvitationClient, err error)
- func NewRecipientInvitationClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client RecipientInvitationClient, err error)
- func (client RecipientInvitationClient) AcceptRecipientInvitation(ctx context.Context, request AcceptRecipientInvitationRequest) (response AcceptRecipientInvitationResponse, err error)
- func (client *RecipientInvitationClient) ConfigurationProvider() *common.ConfigurationProvider
- func (client RecipientInvitationClient) GetRecipientInvitation(ctx context.Context, request GetRecipientInvitationRequest) (response GetRecipientInvitationResponse, err error)
- func (client RecipientInvitationClient) IgnoreRecipientInvitation(ctx context.Context, request IgnoreRecipientInvitationRequest) (response IgnoreRecipientInvitationResponse, err error)
- func (client RecipientInvitationClient) ListRecipientInvitations(ctx context.Context, request ListRecipientInvitationsRequest) (response ListRecipientInvitationsResponse, err error)
- func (client *RecipientInvitationClient) SetRegion(region string)
- func (client RecipientInvitationClient) UpdateRecipientInvitation(ctx context.Context, request UpdateRecipientInvitationRequest) (response UpdateRecipientInvitationResponse, err error)
- type RecipientInvitationCollection
- type RecipientInvitationStatusEnum
- type RecipientInvitationSummary
- type SenderInvitation
- type SenderInvitationClient
- func (client SenderInvitationClient) CancelSenderInvitation(ctx context.Context, request CancelSenderInvitationRequest) (response CancelSenderInvitationResponse, err error)
- func (client *SenderInvitationClient) ConfigurationProvider() *common.ConfigurationProvider
- func (client SenderInvitationClient) CreateSenderInvitation(ctx context.Context, request CreateSenderInvitationRequest) (response CreateSenderInvitationResponse, err error)
- func (client SenderInvitationClient) GetSenderInvitation(ctx context.Context, request GetSenderInvitationRequest) (response GetSenderInvitationResponse, err error)
- func (client SenderInvitationClient) ListSenderInvitations(ctx context.Context, request ListSenderInvitationsRequest) (response ListSenderInvitationsResponse, err error)
- func (client *SenderInvitationClient) SetRegion(region string)
- func (client SenderInvitationClient) UpdateSenderInvitation(ctx context.Context, request UpdateSenderInvitationRequest) (response UpdateSenderInvitationResponse, err error)
- type SenderInvitationCollection
- type SenderInvitationStatusEnum
- type SenderInvitationSummary
- type SortOrderEnum
- type UpdateDomainDetails
- type UpdateDomainGovernanceDetails
- type UpdateDomainGovernanceRequest
- type UpdateDomainGovernanceResponse
- type UpdateDomainRequest
- type UpdateDomainResponse
- type UpdateRecipientInvitationDetails
- type UpdateRecipientInvitationRequest
- type UpdateRecipientInvitationResponse
- type UpdateSenderInvitationDetails
- type UpdateSenderInvitationRequest
- type UpdateSenderInvitationResponse
- type WorkRequest
- type WorkRequestClient
- func (client *WorkRequestClient) ConfigurationProvider() *common.ConfigurationProvider
- func (client WorkRequestClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
- func (client WorkRequestClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
- func (client WorkRequestClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
- func (client WorkRequestClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
- func (client *WorkRequestClient) SetRegion(region string)
- type WorkRequestCollection
- type WorkRequestError
- type WorkRequestErrorCollection
- type WorkRequestLogEntry
- type WorkRequestLogEntryCollection
- type WorkRequestResource
- type WorkRequestSummary
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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 // might be rejected. OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
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) HTTPRequest ¶
func (request AcceptRecipientInvitationRequest) HTTPRequest(method, path 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
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 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
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 // might be rejected. OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
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) HTTPRequest ¶
func (request CancelSenderInvitationRequest) HTTPRequest(method, path 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
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 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 CreateDomainDetails ¶
type CreateDomainDetails struct { // OCID of the tenancy. CompartmentId *string `mandatory:"true" json:"compartmentId"` // The domain name. DomainName *string `mandatory:"true" json:"domainName"` // The email 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
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"` // The email 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
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 // might be rejected. OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
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) HTTPRequest ¶
func (request CreateDomainGovernanceRequest) HTTPRequest(method, path 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
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 // might be rejected. OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
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) HTTPRequest ¶
func (request CreateDomainRequest) HTTPRequest(method, path 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
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 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"` // 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
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 // might be rejected. OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
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) HTTPRequest ¶
func (request CreateSenderInvitationRequest) HTTPRequest(method, path 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
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 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 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) HTTPRequest ¶
func (request DeleteDomainGovernanceRequest) HTTPRequest(method, path 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
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) HTTPRequest ¶
func (request DeleteDomainRequest) HTTPRequest(method, path 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
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) HTTPRequest ¶
func (request DeleteLinkRequest) HTTPRequest(method, path 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
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"` }
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 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 RFC3339-formatted date and time string. TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` // Date-time when this domain was last updated. An RFC3339-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.
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
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"` // The email 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 RFC3339-formatted date and time string. TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` // Date-time when this domain governance was last updated. An RFC3339-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
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
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
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"` // The email 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 RFC3339-formatted date and time string. TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` // Date-time when this domain governance was last updated. An RFC3339-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
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
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
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 RFC3339-formatted date and time string. TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` // Date-time when this domain was last updated. An RFC3339-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
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) HTTPRequest ¶
func (request GetDomainGovernanceRequest) HTTPRequest(method, path 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
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) HTTPRequest ¶
func (request GetDomainRequest) HTTPRequest(method, path 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
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) HTTPRequest ¶
func (request GetLinkRequest) HTTPRequest(method, path 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
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 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) HTTPRequest ¶
func (request GetRecipientInvitationRequest) HTTPRequest(method, path 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
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) HTTPRequest ¶
func (request GetSenderInvitationRequest) HTTPRequest(method, path 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
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 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) HTTPRequest ¶
func (request GetWorkRequestRequest) HTTPRequest(method, path 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
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 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 // might be rejected. OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // The client request ID for tracing. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
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) HTTPRequest ¶
func (request IgnoreRecipientInvitationRequest) HTTPRequest(method, path 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
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 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
type Link ¶
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.
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 (LinkClient) DeleteLink ¶
func (client LinkClient) DeleteLink(ctx context.Context, request DeleteLinkRequest) (response DeleteLinkResponse, err error)
DeleteLink Terminate the link.
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 DeleteLink API.
func (LinkClient) GetLink ¶
func (client LinkClient) GetLink(ctx context.Context, request GetLinkRequest) (response GetLinkResponse, err error)
GetLink Gets information about the link.
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 GetLink API.
func (LinkClient) ListLinks ¶
func (client LinkClient) ListLinks(ctx context.Context, request ListLinksRequest) (response ListLinksResponse, err error)
ListLinks Return a (paginated) list of links.
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 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
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
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
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) HTTPRequest ¶
func (request ListDomainGovernancesRequest) HTTPRequest(method, path 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
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
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
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
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) HTTPRequest ¶
func (request ListDomainsRequest) HTTPRequest(method, path 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
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
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
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
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) HTTPRequest ¶
func (request ListLinksRequest) HTTPRequest(method, path 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
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
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
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) HTTPRequest ¶
func (request ListRecipientInvitationsRequest) HTTPRequest(method, path 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
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
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
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) HTTPRequest ¶
func (request ListSenderInvitationsRequest) HTTPRequest(method, path 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
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
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
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
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) HTTPRequest ¶
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path 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
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
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) HTTPRequest ¶
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path 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
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
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) HTTPRequest ¶
func (request ListWorkRequestsRequest) HTTPRequest(method, path 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
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
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 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" )
Set of constants representing the allowable values for OperationTypeEnum
func GetOperationTypeEnumValues ¶
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
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"` // 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-time when this 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-time when this 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
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 RecipientInvitation.
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
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 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"` // 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-time when this recipient invitation was created. TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"` // Date-time when this 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
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"` // 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-time when this 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-time when this 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
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 SenderInvitation.
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
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 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"` // 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-time when this sender invitation was created. TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"` // OCID of the corresponding recipient invitation. RecipientInvitationId *string `mandatory:"false" json:"recipientInvitationId"` // Date-time when this 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
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 GetSortOrderEnumValues ¶
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
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
type UpdateDomainGovernanceDetails ¶
type UpdateDomainGovernanceDetails struct { // The email 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
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) HTTPRequest ¶
func (request UpdateDomainGovernanceRequest) HTTPRequest(method, path 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
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) HTTPRequest ¶
func (request UpdateDomainRequest) HTTPRequest(method, path 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
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 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
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) HTTPRequest ¶
func (request UpdateRecipientInvitationRequest) HTTPRequest(method, path 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
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
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) HTTPRequest ¶
func (request UpdateSenderInvitationRequest) HTTPRequest(method, path 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
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 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 this work request. Resources []WorkRequestResource `mandatory:"true" json:"resources"` // Percentage of the request completed. PercentComplete *float32 `mandatory:"true" json:"percentComplete"` // The date and time the request was created, as described in // RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29. TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"` // The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), // section 14.29. TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"` // The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339). TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"` }
WorkRequest A description of work request status.
func (WorkRequest) String ¶
func (m WorkRequest) String() string
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
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 RFC3339-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
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
type WorkRequestLogEntry ¶
type WorkRequestLogEntry struct { // Human-readable log message. Message *string `mandatory:"true" json:"message"` // The time the log message was written. An RFC3339-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
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
type WorkRequestResource ¶
type WorkRequestResource struct { // The resource type the work request affects. EntityType *string `mandatory:"true" json:"entityType"` // The way in which this resource is affected by the work tracked in the work request. // A resource being created, updated, or deleted will remain in the IN_PROGRESS state until // work is complete for that resource, at which point it will transition to CREATED, UPDATED, // or DELETED, respectively. ActionType ActionTypeEnum `mandatory:"true" json:"actionType"` // The identifier of the resource the work request affects. Identifier *string `mandatory:"true" json:"identifier"` // The URI path that the user can do a GET on to access the resource metadata. EntityUri *string `mandatory:"false" json:"entityUri"` }
WorkRequestResource A resource created or operated on by a work request.
func (WorkRequestResource) String ¶
func (m WorkRequestResource) String() string
type WorkRequestSummary ¶
type WorkRequestSummary struct { // Type of the work request. OperationType OperationTypeEnum `mandatory:"true" json:"operationType"` // Status of current work request. Status OperationStatusEnum `mandatory:"true" json:"status"` // The ID of the work request. Id *string `mandatory:"true" json:"id"` // The OCID of the compartment that contains the work request. CompartmentId *string `mandatory:"true" json:"compartmentId"` // The resources affected by this work request. Resources []WorkRequestResource `mandatory:"true" json:"resources"` // Percentage of the request completed. PercentComplete *float32 `mandatory:"true" json:"percentComplete"` // The date and time the request was created, as described in // RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29. TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"` // The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), // section 14.29. TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"` // The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339). TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"` }
WorkRequestSummary A summary of work request status.
func (WorkRequestSummary) String ¶
func (m WorkRequestSummary) String() string
Source Files ¶
- accept_recipient_invitation_request_response.go
- action_type.go
- cancel_sender_invitation_request_response.go
- create_domain_details.go
- create_domain_governance_details.go
- create_domain_governance_request_response.go
- create_domain_request_response.go
- create_sender_invitation_details.go
- create_sender_invitation_request_response.go
- delete_domain_governance_request_response.go
- delete_domain_request_response.go
- delete_link_request_response.go
- domain.go
- domain_collection.go
- domain_governance.go
- domain_governance_collection.go
- domain_governance_summary.go
- domain_summary.go
- get_domain_governance_request_response.go
- get_domain_request_response.go
- get_link_request_response.go
- get_recipient_invitation_request_response.go
- get_sender_invitation_request_response.go
- get_work_request_request_response.go
- ignore_recipient_invitation_request_response.go
- lifecycle_state.go
- link.go
- link_collection.go
- link_summary.go
- list_domain_governances_request_response.go
- list_domains_request_response.go
- list_links_request_response.go
- list_recipient_invitations_request_response.go
- list_sender_invitations_request_response.go
- list_work_request_errors_request_response.go
- list_work_request_logs_request_response.go
- list_work_requests_request_response.go
- operation_status.go
- operation_type.go
- recipient_invitation.go
- recipient_invitation_collection.go
- recipient_invitation_status.go
- recipient_invitation_summary.go
- sender_invitation.go
- sender_invitation_collection.go
- sender_invitation_status.go
- sender_invitation_summary.go
- sort_order.go
- tenantmanagercontrolplane_domain_client.go
- tenantmanagercontrolplane_domaingovernance_client.go
- tenantmanagercontrolplane_link_client.go
- tenantmanagercontrolplane_recipientinvitation_client.go
- tenantmanagercontrolplane_senderinvitation_client.go
- tenantmanagercontrolplane_workrequest_client.go
- update_domain_details.go
- update_domain_governance_details.go
- update_domain_governance_request_response.go
- update_domain_request_response.go
- update_recipient_invitation_details.go
- update_recipient_invitation_request_response.go
- update_sender_invitation_details.go
- update_sender_invitation_request_response.go
- work_request.go
- work_request_collection.go
- work_request_error.go
- work_request_error_collection.go
- work_request_log_entry.go
- work_request_log_entry_collection.go
- work_request_resource.go
- work_request_summary.go