...

Package tenantmanagercontrolplane

import "github.com/oracle/oci-go-sdk/tenantmanagercontrolplane"
Overview
Index

Overview ▾

Index ▾

type AcceptRecipientInvitationRequest
    func (request AcceptRecipientInvitationRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request AcceptRecipientInvitationRequest) RetryPolicy() *common.RetryPolicy
    func (request AcceptRecipientInvitationRequest) String() string
type AcceptRecipientInvitationResponse
    func (response AcceptRecipientInvitationResponse) HTTPResponse() *http.Response
    func (response AcceptRecipientInvitationResponse) String() string
type ActionTypeEnum
    func GetActionTypeEnumValues() []ActionTypeEnum
type CancelSenderInvitationRequest
    func (request CancelSenderInvitationRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CancelSenderInvitationRequest) RetryPolicy() *common.RetryPolicy
    func (request CancelSenderInvitationRequest) String() string
type CancelSenderInvitationResponse
    func (response CancelSenderInvitationResponse) HTTPResponse() *http.Response
    func (response CancelSenderInvitationResponse) String() string
type CreateSenderInvitationDetails
    func (m CreateSenderInvitationDetails) String() string
type CreateSenderInvitationRequest
    func (request CreateSenderInvitationRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreateSenderInvitationRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateSenderInvitationRequest) String() string
type CreateSenderInvitationResponse
    func (response CreateSenderInvitationResponse) HTTPResponse() *http.Response
    func (response CreateSenderInvitationResponse) String() string
type DeleteLinkRequest
    func (request DeleteLinkRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DeleteLinkRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteLinkRequest) String() string
type DeleteLinkResponse
    func (response DeleteLinkResponse) HTTPResponse() *http.Response
    func (response DeleteLinkResponse) String() string
type GetLinkRequest
    func (request GetLinkRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetLinkRequest) RetryPolicy() *common.RetryPolicy
    func (request GetLinkRequest) String() string
type GetLinkResponse
    func (response GetLinkResponse) HTTPResponse() *http.Response
    func (response GetLinkResponse) String() string
type GetRecipientInvitationRequest
    func (request GetRecipientInvitationRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetRecipientInvitationRequest) RetryPolicy() *common.RetryPolicy
    func (request GetRecipientInvitationRequest) String() string
type GetRecipientInvitationResponse
    func (response GetRecipientInvitationResponse) HTTPResponse() *http.Response
    func (response GetRecipientInvitationResponse) String() string
type GetSenderInvitationRequest
    func (request GetSenderInvitationRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetSenderInvitationRequest) RetryPolicy() *common.RetryPolicy
    func (request GetSenderInvitationRequest) String() string
type GetSenderInvitationResponse
    func (response GetSenderInvitationResponse) HTTPResponse() *http.Response
    func (response GetSenderInvitationResponse) String() string
type GetWorkRequestRequest
    func (request GetWorkRequestRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
    func (request GetWorkRequestRequest) String() string
type GetWorkRequestResponse
    func (response GetWorkRequestResponse) HTTPResponse() *http.Response
    func (response GetWorkRequestResponse) String() string
type IgnoreRecipientInvitationRequest
    func (request IgnoreRecipientInvitationRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request IgnoreRecipientInvitationRequest) RetryPolicy() *common.RetryPolicy
    func (request IgnoreRecipientInvitationRequest) String() string
type IgnoreRecipientInvitationResponse
    func (response IgnoreRecipientInvitationResponse) HTTPResponse() *http.Response
    func (response IgnoreRecipientInvitationResponse) String() string
type LifecycleStateEnum
    func GetLifecycleStateEnumValues() []LifecycleStateEnum
type Link
    func (m Link) String() string
type LinkClient
    func NewLinkClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client LinkClient, err error)
    func NewLinkClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client LinkClient, err error)
    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
    func (m LinkCollection) String() string
type LinkSummary
    func (m LinkSummary) String() string
type ListLinksLifecycleStateEnum
    func GetListLinksLifecycleStateEnumValues() []ListLinksLifecycleStateEnum
type ListLinksRequest
    func (request ListLinksRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListLinksRequest) RetryPolicy() *common.RetryPolicy
    func (request ListLinksRequest) String() string
type ListLinksResponse
    func (response ListLinksResponse) HTTPResponse() *http.Response
    func (response ListLinksResponse) String() string
type ListLinksSortOrderEnum
    func GetListLinksSortOrderEnumValues() []ListLinksSortOrderEnum
type ListRecipientInvitationsLifecycleStateEnum
    func GetListRecipientInvitationsLifecycleStateEnumValues() []ListRecipientInvitationsLifecycleStateEnum
type ListRecipientInvitationsRequest
    func (request ListRecipientInvitationsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListRecipientInvitationsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListRecipientInvitationsRequest) String() string
type ListRecipientInvitationsResponse
    func (response ListRecipientInvitationsResponse) HTTPResponse() *http.Response
    func (response ListRecipientInvitationsResponse) String() string
type ListRecipientInvitationsStatusEnum
    func GetListRecipientInvitationsStatusEnumValues() []ListRecipientInvitationsStatusEnum
type ListSenderInvitationsLifecycleStateEnum
    func GetListSenderInvitationsLifecycleStateEnumValues() []ListSenderInvitationsLifecycleStateEnum
type ListSenderInvitationsRequest
    func (request ListSenderInvitationsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListSenderInvitationsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListSenderInvitationsRequest) String() string
type ListSenderInvitationsResponse
    func (response ListSenderInvitationsResponse) HTTPResponse() *http.Response
    func (response ListSenderInvitationsResponse) String() string
type ListSenderInvitationsSortByEnum
    func GetListSenderInvitationsSortByEnumValues() []ListSenderInvitationsSortByEnum
type ListSenderInvitationsSortOrderEnum
    func GetListSenderInvitationsSortOrderEnumValues() []ListSenderInvitationsSortOrderEnum
type ListSenderInvitationsStatusEnum
    func GetListSenderInvitationsStatusEnumValues() []ListSenderInvitationsStatusEnum
type ListWorkRequestErrorsRequest
    func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestErrorsRequest) String() string
type ListWorkRequestErrorsResponse
    func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestErrorsResponse) String() string
type ListWorkRequestErrorsSortOrderEnum
    func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
type ListWorkRequestLogsRequest
    func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestLogsRequest) String() string
type ListWorkRequestLogsResponse
    func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestLogsResponse) String() string
type ListWorkRequestLogsSortOrderEnum
    func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
type ListWorkRequestsRequest
    func (request ListWorkRequestsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestsRequest) String() string
type ListWorkRequestsResponse
    func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestsResponse) String() string
type ListWorkRequestsSortOrderEnum
    func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
type OperationStatusEnum
    func GetOperationStatusEnumValues() []OperationStatusEnum
type OperationTypeEnum
    func GetOperationTypeEnumValues() []OperationTypeEnum
type RecipientInvitation
    func (m RecipientInvitation) String() string
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
    func (m RecipientInvitationCollection) String() string
type RecipientInvitationStatusEnum
    func GetRecipientInvitationStatusEnumValues() []RecipientInvitationStatusEnum
type RecipientInvitationSummary
    func (m RecipientInvitationSummary) String() string
type SenderInvitation
    func (m SenderInvitation) String() string
type SenderInvitationClient
    func NewSenderInvitationClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client SenderInvitationClient, err error)
    func NewSenderInvitationClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client SenderInvitationClient, err error)
    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
    func (m SenderInvitationCollection) String() string
type SenderInvitationStatusEnum
    func GetSenderInvitationStatusEnumValues() []SenderInvitationStatusEnum
type SenderInvitationSummary
    func (m SenderInvitationSummary) String() string
type SortOrderEnum
    func GetSortOrderEnumValues() []SortOrderEnum
type UpdateRecipientInvitationDetails
    func (m UpdateRecipientInvitationDetails) String() string
type UpdateRecipientInvitationRequest
    func (request UpdateRecipientInvitationRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdateRecipientInvitationRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateRecipientInvitationRequest) String() string
type UpdateRecipientInvitationResponse
    func (response UpdateRecipientInvitationResponse) HTTPResponse() *http.Response
    func (response UpdateRecipientInvitationResponse) String() string
type UpdateSenderInvitationDetails
    func (m UpdateSenderInvitationDetails) String() string
type UpdateSenderInvitationRequest
    func (request UpdateSenderInvitationRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdateSenderInvitationRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateSenderInvitationRequest) String() string
type UpdateSenderInvitationResponse
    func (response UpdateSenderInvitationResponse) HTTPResponse() *http.Response
    func (response UpdateSenderInvitationResponse) String() string
type WorkRequest
    func (m WorkRequest) String() string
type WorkRequestClient
    func NewWorkRequestClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client WorkRequestClient, err error)
    func NewWorkRequestClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client WorkRequestClient, err error)
    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
    func (m WorkRequestCollection) String() string
type WorkRequestError
    func (m WorkRequestError) String() string
type WorkRequestErrorCollection
    func (m WorkRequestErrorCollection) String() string
type WorkRequestLogEntry
    func (m WorkRequestLogEntry) String() string
type WorkRequestLogEntryCollection
    func (m WorkRequestLogEntryCollection) String() string
type WorkRequestResource
    func (m WorkRequestResource) String() string
type WorkRequestSummary
    func (m WorkRequestSummary) String() string

Package files

accept_recipient_invitation_request_response.go action_type.go cancel_sender_invitation_request_response.go create_sender_invitation_details.go create_sender_invitation_request_response.go delete_link_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_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_link_client.go tenantmanagercontrolplane_recipientinvitation_client.go tenantmanagercontrolplane_senderinvitation_client.go tenantmanagercontrolplane_workrequest_client.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

type AcceptRecipientInvitationRequest

AcceptRecipientInvitationRequest wrapper for the AcceptRecipientInvitation operation

See also

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

type AcceptRecipientInvitationRequest struct {

    // OCID of recipient invitation to accept.
    RecipientInvitationId *string `mandatory:"true" contributesTo:"path" name:"recipientInvitationId"`

    // For optimistic concurrency control. In the PUT or DELETE call
    // for a resource, set the `if-match` parameter to the value of the
    // etag from a previous GET or POST response for that resource.
    // The resource will be updated or deleted only if the etag you
    // provide matches the resource's current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of executing that same action again. Retry tokens expire after 24
    // hours, but can be invalidated before then due to conflicting operations. For example, if a resource
    // has been deleted and purged from the system, then a retry of the original creation request
    // might be rejected.
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (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

AcceptRecipientInvitationResponse wrapper for the AcceptRecipientInvitation operation

type AcceptRecipientInvitationResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

func (AcceptRecipientInvitationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (AcceptRecipientInvitationResponse) String

func (response AcceptRecipientInvitationResponse) String() string

type ActionTypeEnum

ActionTypeEnum Enum with underlying type: string

type ActionTypeEnum string

Set of constants representing the allowable values for ActionTypeEnum

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

func GetActionTypeEnumValues

func GetActionTypeEnumValues() []ActionTypeEnum

GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum

type CancelSenderInvitationRequest

CancelSenderInvitationRequest wrapper for the CancelSenderInvitation operation

See also

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

type CancelSenderInvitationRequest struct {

    // OCID of the sender invitation to cancel.
    SenderInvitationId *string `mandatory:"true" contributesTo:"path" name:"senderInvitationId"`

    // For optimistic concurrency control. In the PUT or DELETE call
    // for a resource, set the `if-match` parameter to the value of the
    // etag from a previous GET or POST response for that resource.
    // The resource will be updated or deleted only if the etag you
    // provide matches the resource's current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of executing that same action again. Retry tokens expire after 24
    // hours, but can be invalidated before then due to conflicting operations. For example, if a resource
    // has been deleted and purged from the system, then a retry of the original creation request
    // might be rejected.
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (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

CancelSenderInvitationResponse wrapper for the CancelSenderInvitation operation

type CancelSenderInvitationResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

func (CancelSenderInvitationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CancelSenderInvitationResponse) String

func (response CancelSenderInvitationResponse) String() string

type CreateSenderInvitationDetails

CreateSenderInvitationDetails The parameters for creating a sender invitation.

type CreateSenderInvitationDetails struct {

    // OCID of the sender tenancy.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // OCID of the recipient tenancy.
    RecipientTenancyId *string `mandatory:"true" json:"recipientTenancyId"`

    // Email address of the recipient.
    RecipientEmailAddress *string `mandatory:"false" json:"recipientEmailAddress"`

    // A user-created name to describe the invitation.
    DisplayName *string `mandatory:"false" json:"displayName"`

    // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
    // Example: `{"bar-key": "value"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // Example: `{"foo-namespace": {"bar-key": "value"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (CreateSenderInvitationDetails) String

func (m CreateSenderInvitationDetails) String() string

type CreateSenderInvitationRequest

CreateSenderInvitationRequest wrapper for the CreateSenderInvitation operation

See also

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

type CreateSenderInvitationRequest struct {

    // Parameters for sender invitation creation.
    CreateSenderInvitationDetails `contributesTo:"body"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of executing that same action again. Retry tokens expire after 24
    // hours, but can be invalidated before then due to conflicting operations. For example, if a resource
    // has been deleted and purged from the system, then a retry of the original creation request
    // might be rejected.
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (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

CreateSenderInvitationResponse wrapper for the CreateSenderInvitation operation

type CreateSenderInvitationResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The SenderInvitation instance
    SenderInvitation `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`
}

func (CreateSenderInvitationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateSenderInvitationResponse) String

func (response CreateSenderInvitationResponse) String() string

type DeleteLinkRequest

DeleteLinkRequest wrapper for the DeleteLink operation

See also

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

type DeleteLinkRequest struct {

    // OCID of the link to terminate.
    LinkId *string `mandatory:"true" contributesTo:"path" name:"linkId"`

    // For optimistic concurrency control. In the PUT or DELETE call
    // for a resource, set the `if-match` parameter to the value of the
    // etag from a previous GET or POST response for that resource.
    // The resource will be updated or deleted only if the etag you
    // provide matches the resource's current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (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

DeleteLinkResponse wrapper for the DeleteLink operation

type DeleteLinkResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (DeleteLinkResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteLinkResponse) String

func (response DeleteLinkResponse) String() string

type GetLinkRequest

GetLinkRequest wrapper for the GetLink operation

See also

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

type GetLinkRequest struct {

    // OCID of the link to retrieve.
    LinkId *string `mandatory:"true" contributesTo:"path" name:"linkId"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (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

GetLinkResponse wrapper for the GetLink operation

type GetLinkResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Link instance
    Link `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (GetLinkResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetLinkResponse) String

func (response GetLinkResponse) String() string

type GetRecipientInvitationRequest

GetRecipientInvitationRequest wrapper for the GetRecipientInvitation operation

See also

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

type GetRecipientInvitationRequest struct {

    // OCID of the recipient invitation to retrieve.
    RecipientInvitationId *string `mandatory:"true" contributesTo:"path" name:"recipientInvitationId"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (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

GetRecipientInvitationResponse wrapper for the GetRecipientInvitation operation

type GetRecipientInvitationResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The RecipientInvitation instance
    RecipientInvitation `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`
}

func (GetRecipientInvitationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetRecipientInvitationResponse) String

func (response GetRecipientInvitationResponse) String() string

type GetSenderInvitationRequest

GetSenderInvitationRequest wrapper for the GetSenderInvitation operation

See also

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

type GetSenderInvitationRequest struct {

    // OCID of the sender invitation to retrieve.
    SenderInvitationId *string `mandatory:"true" contributesTo:"path" name:"senderInvitationId"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (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

GetSenderInvitationResponse wrapper for the GetSenderInvitation operation

type GetSenderInvitationResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The SenderInvitation instance
    SenderInvitation `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (GetSenderInvitationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetSenderInvitationResponse) String

func (response GetSenderInvitationResponse) String() string

type GetWorkRequestRequest

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

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

type GetWorkRequestRequest struct {

    // The ID of the asynchronous request.
    WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (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

GetWorkRequestResponse wrapper for the GetWorkRequest operation

type GetWorkRequestResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The WorkRequest instance
    WorkRequest `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // A decimal number representing the number of seconds the client should wait before polling this endpoint again.
    RetryAfter *float32 `presentIn:"header" name:"retry-after"`
}

func (GetWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String

func (response GetWorkRequestResponse) String() string

type IgnoreRecipientInvitationRequest

IgnoreRecipientInvitationRequest wrapper for the IgnoreRecipientInvitation operation

See also

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

type IgnoreRecipientInvitationRequest struct {

    // OCID of recipient invitation to ignore.
    RecipientInvitationId *string `mandatory:"true" contributesTo:"path" name:"recipientInvitationId"`

    // For optimistic concurrency control. In the PUT or DELETE call
    // for a resource, set the `if-match` parameter to the value of the
    // etag from a previous GET or POST response for that resource.
    // The resource will be updated or deleted only if the etag you
    // provide matches the resource's current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // A token that uniquely identifies a request so it can be retried in case of a timeout or
    // server error without risk of executing that same action again. Retry tokens expire after 24
    // hours, but can be invalidated before then due to conflicting operations. For example, if a resource
    // has been deleted and purged from the system, then a retry of the original creation request
    // might be rejected.
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (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

IgnoreRecipientInvitationResponse wrapper for the IgnoreRecipientInvitation operation

type IgnoreRecipientInvitationResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The RecipientInvitation instance
    RecipientInvitation `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`
}

func (IgnoreRecipientInvitationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (IgnoreRecipientInvitationResponse) String

func (response IgnoreRecipientInvitationResponse) String() string

type LifecycleStateEnum

LifecycleStateEnum Enum with underlying type: string

type LifecycleStateEnum string

Set of constants representing the allowable values for LifecycleStateEnum

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

func GetLifecycleStateEnumValues

func GetLifecycleStateEnumValues() []LifecycleStateEnum

GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum

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

type Link struct {

    // OCID of the link.
    Id *string `mandatory:"true" json:"id"`

    // OCID of the parent tenancy.
    ParentTenancyId *string `mandatory:"true" json:"parentTenancyId"`

    // OCID of the child tenancy
    ChildTenancyId *string `mandatory:"true" json:"childTenancyId"`

    // Date-time when this link was created.
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // Lifecycle state of the link.
    LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

    // Date-time when this link was last updated.
    TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

    // Date-time when this link was terminated.
    TimeTerminated *common.SDKTime `mandatory:"false" json:"timeTerminated"`
}

func (Link) String

func (m Link) String() string

type LinkClient

LinkClient a client for Link

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

func NewLinkClientWithConfigurationProvider

func NewLinkClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client LinkClient, err error)

NewLinkClientWithConfigurationProvider Creates a new default Link client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewLinkClientWithOboToken

func NewLinkClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client LinkClient, err error)

NewLinkClientWithOboToken Creates a new default Link client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer

as well as reading the region

func (*LinkClient) ConfigurationProvider

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

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

func (client LinkClient) DeleteLink(ctx context.Context, request DeleteLinkRequest) (response DeleteLinkResponse, err error)

DeleteLink Terminate the link.

See also

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

func (client LinkClient) GetLink(ctx context.Context, request GetLinkRequest) (response GetLinkResponse, err error)

GetLink Gets information about the link.

See also

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

func (client LinkClient) ListLinks(ctx context.Context, request ListLinksRequest) (response ListLinksResponse, err error)

ListLinks Return a (paginated) list of links.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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

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

type LinkCollection struct {

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

func (LinkCollection) String

func (m LinkCollection) String() string

type LinkSummary

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

type LinkSummary struct {

    // OCID of the link.
    Id *string `mandatory:"true" json:"id"`

    // OCID of the parent tenancy.
    ParentTenancyId *string `mandatory:"true" json:"parentTenancyId"`

    // OCID of the child tenancy.
    ChildTenancyId *string `mandatory:"true" json:"childTenancyId"`

    // Date-time when this link was created
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // Lifecycle state of the link.
    LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

    // Date-time when this link was last updated.
    TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

    // Date-time when this link was terminated.
    TimeTerminated *common.SDKTime `mandatory:"false" json:"timeTerminated"`
}

func (LinkSummary) String

func (m LinkSummary) String() string

type ListLinksLifecycleStateEnum

ListLinksLifecycleStateEnum Enum with underlying type: string

type ListLinksLifecycleStateEnum string

Set of constants representing the allowable values for ListLinksLifecycleStateEnum

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

func GetListLinksLifecycleStateEnumValues

func GetListLinksLifecycleStateEnumValues() []ListLinksLifecycleStateEnum

GetListLinksLifecycleStateEnumValues Enumerates the set of values for ListLinksLifecycleStateEnum

type ListLinksRequest

ListLinksRequest wrapper for the ListLinks operation

See also

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

type ListLinksRequest struct {

    // The ID of the parent tenancy this link is associated with.
    ParentTenancyId *string `mandatory:"false" contributesTo:"query" name:"parentTenancyId"`

    // The ID of the child tenancy this link is associated with.
    ChildTenancyId *string `mandatory:"false" contributesTo:"query" name:"childTenancyId"`

    // The lifecycle state of the resource.
    LifecycleState ListLinksLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The maximum number of items to return.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The sort order to use, either 'asc' or 'desc'.
    SortOrder ListLinksSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (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

ListLinksResponse wrapper for the ListLinks operation

type ListLinksResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of LinkCollection instances
    LinkCollection `presentIn:"body"`

    // For pagination of a list of items. When paging through a list, if this header appears in the response,
    // then a partial list might have been returned. Include this value as the `page` parameter for the
    // subsequent GET request to get the next batch of items.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ListLinksResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListLinksResponse) String

func (response ListLinksResponse) String() string

type ListLinksSortOrderEnum

ListLinksSortOrderEnum Enum with underlying type: string

type ListLinksSortOrderEnum string

Set of constants representing the allowable values for ListLinksSortOrderEnum

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

func GetListLinksSortOrderEnumValues

func GetListLinksSortOrderEnumValues() []ListLinksSortOrderEnum

GetListLinksSortOrderEnumValues Enumerates the set of values for ListLinksSortOrderEnum

type ListRecipientInvitationsLifecycleStateEnum

ListRecipientInvitationsLifecycleStateEnum Enum with underlying type: string

type ListRecipientInvitationsLifecycleStateEnum string

Set of constants representing the allowable values for ListRecipientInvitationsLifecycleStateEnum

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

func GetListRecipientInvitationsLifecycleStateEnumValues

func GetListRecipientInvitationsLifecycleStateEnumValues() []ListRecipientInvitationsLifecycleStateEnum

GetListRecipientInvitationsLifecycleStateEnumValues Enumerates the set of values for ListRecipientInvitationsLifecycleStateEnum

type ListRecipientInvitationsRequest

ListRecipientInvitationsRequest wrapper for the ListRecipientInvitations operation

See also

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

type ListRecipientInvitationsRequest struct {

    // The ID of the compartment in which to list resources.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // The tenancy that sent the invitation.
    SenderTenancyId *string `mandatory:"false" contributesTo:"query" name:"senderTenancyId"`

    // The lifecycle state of the resource.
    LifecycleState ListRecipientInvitationsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

    // The status of the recipient invitation.
    Status ListRecipientInvitationsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (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

ListRecipientInvitationsResponse wrapper for the ListRecipientInvitations operation

type ListRecipientInvitationsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of RecipientInvitationCollection instances
    RecipientInvitationCollection `presentIn:"body"`

    // For pagination of a list of items. When paging through a list, if this header appears in the response,
    // then a partial list might have been returned. Include this value as the `page` parameter for the
    // subsequent GET request to get the next batch of items.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ListRecipientInvitationsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListRecipientInvitationsResponse) String

func (response ListRecipientInvitationsResponse) String() string

type ListRecipientInvitationsStatusEnum

ListRecipientInvitationsStatusEnum Enum with underlying type: string

type ListRecipientInvitationsStatusEnum string

Set of constants representing the allowable values for ListRecipientInvitationsStatusEnum

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

func GetListRecipientInvitationsStatusEnumValues

func GetListRecipientInvitationsStatusEnumValues() []ListRecipientInvitationsStatusEnum

GetListRecipientInvitationsStatusEnumValues Enumerates the set of values for ListRecipientInvitationsStatusEnum

type ListSenderInvitationsLifecycleStateEnum

ListSenderInvitationsLifecycleStateEnum Enum with underlying type: string

type ListSenderInvitationsLifecycleStateEnum string

Set of constants representing the allowable values for ListSenderInvitationsLifecycleStateEnum

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

func GetListSenderInvitationsLifecycleStateEnumValues

func GetListSenderInvitationsLifecycleStateEnumValues() []ListSenderInvitationsLifecycleStateEnum

GetListSenderInvitationsLifecycleStateEnumValues Enumerates the set of values for ListSenderInvitationsLifecycleStateEnum

type ListSenderInvitationsRequest

ListSenderInvitationsRequest wrapper for the ListSenderInvitations operation

See also

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

type ListSenderInvitationsRequest struct {

    // The ID of the compartment in which to list resources.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // The tenancy that the invitation is addressed to.
    RecipientTenancyId *string `mandatory:"false" contributesTo:"query" name:"recipientTenancyId"`

    // The lifecycle state of the resource.
    LifecycleState ListSenderInvitationsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

    // The status of the sender invitation.
    Status ListSenderInvitationsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`

    // A filter to return only resources that match the entire display name given.
    DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The maximum number of items to return.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
    SortBy ListSenderInvitationsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // The sort order to use, either 'asc' or 'desc'.
    SortOrder ListSenderInvitationsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (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

ListSenderInvitationsResponse wrapper for the ListSenderInvitations operation

type ListSenderInvitationsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of SenderInvitationCollection instances
    SenderInvitationCollection `presentIn:"body"`

    // For pagination of a list of items. When paging through a list, if this header appears in the response,
    // then a partial list might have been returned. Include this value as the `page` parameter for the
    // subsequent GET request to get the next batch of items.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ListSenderInvitationsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListSenderInvitationsResponse) String

func (response ListSenderInvitationsResponse) String() string

type ListSenderInvitationsSortByEnum

ListSenderInvitationsSortByEnum Enum with underlying type: string

type ListSenderInvitationsSortByEnum string

Set of constants representing the allowable values for ListSenderInvitationsSortByEnum

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

func GetListSenderInvitationsSortByEnumValues

func GetListSenderInvitationsSortByEnumValues() []ListSenderInvitationsSortByEnum

GetListSenderInvitationsSortByEnumValues Enumerates the set of values for ListSenderInvitationsSortByEnum

type ListSenderInvitationsSortOrderEnum

ListSenderInvitationsSortOrderEnum Enum with underlying type: string

type ListSenderInvitationsSortOrderEnum string

Set of constants representing the allowable values for ListSenderInvitationsSortOrderEnum

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

func GetListSenderInvitationsSortOrderEnumValues

func GetListSenderInvitationsSortOrderEnumValues() []ListSenderInvitationsSortOrderEnum

GetListSenderInvitationsSortOrderEnumValues Enumerates the set of values for ListSenderInvitationsSortOrderEnum

type ListSenderInvitationsStatusEnum

ListSenderInvitationsStatusEnum Enum with underlying type: string

type ListSenderInvitationsStatusEnum string

Set of constants representing the allowable values for ListSenderInvitationsStatusEnum

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

func GetListSenderInvitationsStatusEnumValues

func GetListSenderInvitationsStatusEnumValues() []ListSenderInvitationsStatusEnum

GetListSenderInvitationsStatusEnumValues Enumerates the set of values for ListSenderInvitationsStatusEnum

type ListWorkRequestErrorsRequest

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

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

type ListWorkRequestErrorsRequest struct {

    // The ID of the asynchronous request.
    WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

    // The 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, either 'asc' or 'desc'.
    SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (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

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

type ListWorkRequestErrorsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of WorkRequestErrorCollection instances
    WorkRequestErrorCollection `presentIn:"body"`

    // For pagination of a list of items. When paging through a list, if this header appears in the response,
    // then a partial list might have been returned. Include this value as the `page` parameter for the
    // subsequent GET request to get the next batch of items.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ListWorkRequestErrorsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortOrderEnum

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string

type ListWorkRequestErrorsSortOrderEnum string

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

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

func GetListWorkRequestErrorsSortOrderEnumValues

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

type ListWorkRequestLogsRequest

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

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

type ListWorkRequestLogsRequest struct {

    // The ID of the asynchronous request.
    WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

    // The 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, either 'asc' or 'desc'.
    SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (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

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

type ListWorkRequestLogsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of WorkRequestLogEntryCollection instances
    WorkRequestLogEntryCollection `presentIn:"body"`

    // For pagination of a list of items. When paging through a list, if this header appears in the response,
    // then a partial list might have been returned. Include this value as the `page` parameter for the
    // subsequent GET request to get the next batch of items.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ListWorkRequestLogsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortOrderEnum

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string

type ListWorkRequestLogsSortOrderEnum string

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

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

func GetListWorkRequestLogsSortOrderEnumValues

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

type ListWorkRequestsRequest

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

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

type ListWorkRequestsRequest struct {

    // The ID of the compartment in which to list resources.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The maximum number of items to return.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The sort order to use, either 'asc' or 'desc'.
    SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (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

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

type ListWorkRequestsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of WorkRequestCollection instances
    WorkRequestCollection `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // For pagination of a list of items. When paging through a list, if this header appears in the response,
    // then a partial list might have been returned. Include this value as the `page` parameter for the
    // subsequent GET request to get the next batch of items.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

func (ListWorkRequestsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortOrderEnum

ListWorkRequestsSortOrderEnum Enum with underlying type: string

type ListWorkRequestsSortOrderEnum string

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

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

func GetListWorkRequestsSortOrderEnumValues

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

type OperationStatusEnum

OperationStatusEnum Enum with underlying type: string

type OperationStatusEnum string

Set of constants representing the allowable values for OperationStatusEnum

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

func GetOperationStatusEnumValues

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypeEnum

OperationTypeEnum Enum with underlying type: string

type OperationTypeEnum string

Set of constants representing the allowable values for OperationTypeEnum

const (
    OperationTypeCreateSenderInvitation    OperationTypeEnum = "CREATE_SENDER_INVITATION"
    OperationTypeAcceptRecipientInvitation OperationTypeEnum = "ACCEPT_RECIPIENT_INVITATION"
    OperationTypeCancelSenderInvitation    OperationTypeEnum = "CANCEL_SENDER_INVITATION"
)

func GetOperationTypeEnumValues

func GetOperationTypeEnumValues() []OperationTypeEnum

GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum

type RecipientInvitation

RecipientInvitation The invitation model that the recipient owns.

type RecipientInvitation struct {

    // OCID of the recipient invitation.
    Id *string `mandatory:"true" json:"id"`

    // OCID of the recipient tenancy.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

func (RecipientInvitation) String

func (m RecipientInvitation) String() string

type RecipientInvitationClient

RecipientInvitationClient a client for RecipientInvitation

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

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/36.1.0/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/36.1.0/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/36.1.0/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/36.1.0/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/36.1.0/tenantmanagercontrolplane/UpdateRecipientInvitation.go.html to see an example of how to use UpdateRecipientInvitation API.

type RecipientInvitationCollection

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

type RecipientInvitationCollection struct {

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

func (RecipientInvitationCollection) String

func (m RecipientInvitationCollection) String() string

type RecipientInvitationStatusEnum

RecipientInvitationStatusEnum Enum with underlying type: string

type RecipientInvitationStatusEnum string

Set of constants representing the allowable values for RecipientInvitationStatusEnum

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

func GetRecipientInvitationStatusEnumValues

func GetRecipientInvitationStatusEnumValues() []RecipientInvitationStatusEnum

GetRecipientInvitationStatusEnumValues Enumerates the set of values for RecipientInvitationStatusEnum

type RecipientInvitationSummary

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

type RecipientInvitationSummary struct {

    // OCID of the recipient invitation.
    Id *string `mandatory:"true" json:"id"`

    // OCID of the recipient tenancy.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // A user-created name to describe the invitation.
    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"`
}

func (RecipientInvitationSummary) String

func (m RecipientInvitationSummary) String() string

type SenderInvitation

SenderInvitation The invitation model that the sender owns.

type SenderInvitation struct {

    // OCID of the sender invitation.
    Id *string `mandatory:"true" json:"id"`

    // OCID of the sender tenancy.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

func (SenderInvitation) String

func (m SenderInvitation) String() string

type SenderInvitationClient

SenderInvitationClient a client for SenderInvitation

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

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/36.1.0/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 recipient.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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/36.1.0/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/36.1.0/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/36.1.0/tenantmanagercontrolplane/UpdateSenderInvitation.go.html to see an example of how to use UpdateSenderInvitation API.

type SenderInvitationCollection

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

type SenderInvitationCollection struct {

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

func (SenderInvitationCollection) String

func (m SenderInvitationCollection) String() string

type SenderInvitationStatusEnum

SenderInvitationStatusEnum Enum with underlying type: string

type SenderInvitationStatusEnum string

Set of constants representing the allowable values for SenderInvitationStatusEnum

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

func GetSenderInvitationStatusEnumValues

func GetSenderInvitationStatusEnumValues() []SenderInvitationStatusEnum

GetSenderInvitationStatusEnumValues Enumerates the set of values for SenderInvitationStatusEnum

type SenderInvitationSummary

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

type SenderInvitationSummary struct {

    // OCID of the sender invitation.
    Id *string `mandatory:"true" json:"id"`

    // OCID of the sender tenancy.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // A user-created name to describe the invitation.
    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"`
}

func (SenderInvitationSummary) String

func (m SenderInvitationSummary) String() string

type SortOrderEnum

SortOrderEnum Enum with underlying type: string

type SortOrderEnum string

Set of constants representing the allowable values for SortOrderEnum

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

func GetSortOrderEnumValues

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type UpdateRecipientInvitationDetails

UpdateRecipientInvitationDetails The parameters for updating a recipient invitation.

type UpdateRecipientInvitationDetails struct {

    // A user-created name to describe the invitation.
    DisplayName *string `mandatory:"false" json:"displayName"`

    // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
    // Example: `{"bar-key": "value"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // Example: `{"foo-namespace": {"bar-key": "value"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (UpdateRecipientInvitationDetails) String

func (m UpdateRecipientInvitationDetails) String() string

type UpdateRecipientInvitationRequest

UpdateRecipientInvitationRequest wrapper for the UpdateRecipientInvitation operation

See also

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

type UpdateRecipientInvitationRequest struct {

    // OCID of the recipient invitation to update.
    RecipientInvitationId *string `mandatory:"true" contributesTo:"path" name:"recipientInvitationId"`

    // The information to be updated.
    UpdateRecipientInvitationDetails `contributesTo:"body"`

    // For optimistic concurrency control. In the PUT or DELETE call
    // for a resource, set the `if-match` parameter to the value of the
    // etag from a previous GET or POST response for that resource.
    // The resource will be updated or deleted only if the etag you
    // provide matches the resource's current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (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

UpdateRecipientInvitationResponse wrapper for the UpdateRecipientInvitation operation

type UpdateRecipientInvitationResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The RecipientInvitation instance
    RecipientInvitation `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`
}

func (UpdateRecipientInvitationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateRecipientInvitationResponse) String

func (response UpdateRecipientInvitationResponse) String() string

type UpdateSenderInvitationDetails

UpdateSenderInvitationDetails The parameters for updating a sender invitation.

type UpdateSenderInvitationDetails struct {

    // A user-created name to describe the invitation.
    DisplayName *string `mandatory:"false" json:"displayName"`

    // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
    // Example: `{"bar-key": "value"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // Example: `{"foo-namespace": {"bar-key": "value"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (UpdateSenderInvitationDetails) String

func (m UpdateSenderInvitationDetails) String() string

type UpdateSenderInvitationRequest

UpdateSenderInvitationRequest wrapper for the UpdateSenderInvitation operation

See also

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

type UpdateSenderInvitationRequest struct {

    // OCID of the sender invitation to update.
    SenderInvitationId *string `mandatory:"true" contributesTo:"path" name:"senderInvitationId"`

    // The information to be updated.
    UpdateSenderInvitationDetails `contributesTo:"body"`

    // For optimistic concurrency control. In the PUT or DELETE call
    // for a resource, set the `if-match` parameter to the value of the
    // etag from a previous GET or POST response for that resource.
    // The resource will be updated or deleted only if the etag you
    // provide matches the resource's current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (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

UpdateSenderInvitationResponse wrapper for the UpdateSenderInvitation operation

type UpdateSenderInvitationResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The SenderInvitation instance
    SenderInvitation `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact
    // Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`
}

func (UpdateSenderInvitationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateSenderInvitationResponse) String

func (response UpdateSenderInvitationResponse) String() string

type WorkRequest

WorkRequest A description of workrequest status.

type WorkRequest struct {

    // Type of the work request.
    OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`

    // Status of current work request.
    Status OperationStatusEnum `mandatory:"true" json:"status"`

    // The ID of the work request.
    Id *string `mandatory:"true" json:"id"`

    // The ocid of the compartment that contains the work request. Work requests should be scoped to
    // the same compartment as the resource the work request affects. If the work request affects multiple resources,
    // and those resources are not in the same compartment, it is up to the service team to pick the primary
    // resource whose compartment should be used.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The resources affected by this work request.
    Resources []WorkRequestResource `mandatory:"true" json:"resources"`

    // Percentage of the request completed.
    PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

    // The date and time the request was created, as described in
    // RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
    TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

    // The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
    // section 14.29.
    TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

    // The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
    TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}

func (WorkRequest) String

func (m WorkRequest) String() string

type WorkRequestClient

WorkRequestClient a client for WorkRequest

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

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/36.1.0/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/36.1.0/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/36.1.0/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/36.1.0/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

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

type WorkRequestCollection struct {

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

func (WorkRequestCollection) String

func (m WorkRequestCollection) String() string

type WorkRequestError

WorkRequestError An error encountered while executing a work request.

type WorkRequestError struct {

    // A machine-usable code for the error that occured. Error codes are listed on
    // (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm).
    Code *string `mandatory:"true" json:"code"`

    // A human readable description of the issue encountered.
    Message *string `mandatory:"true" json:"message"`

    // The time the error occured. An RFC3339 formatted datetime string.
    Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

func (WorkRequestError) String

func (m WorkRequestError) String() string

type WorkRequestErrorCollection

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

type WorkRequestErrorCollection struct {

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

func (WorkRequestErrorCollection) String

func (m WorkRequestErrorCollection) String() string

type WorkRequestLogEntry

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

type WorkRequestLogEntry struct {

    // Human-readable log message.
    Message *string `mandatory:"true" json:"message"`

    // The time the log message was written. An RFC3339 formatted datetime string.
    Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

func (WorkRequestLogEntry) String

func (m WorkRequestLogEntry) String() string

type WorkRequestLogEntryCollection

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

type WorkRequestLogEntryCollection struct {

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

func (WorkRequestLogEntryCollection) String

func (m WorkRequestLogEntryCollection) String() string

type WorkRequestResource

WorkRequestResource A resource created or operated on by a work request.

type WorkRequestResource struct {

    // The resource type the work request affects.
    EntityType *string `mandatory:"true" json:"entityType"`

    // The way in which this resource is affected by the work tracked in the work request.
    // A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
    // work is complete for that resource at which point it will transition to CREATED, UPDATED,
    // or DELETED, respectively.
    ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`

    // The identifier of the resource the work request affects.
    Identifier *string `mandatory:"true" json:"identifier"`

    // The URI path that the user can do a GET on to access the resource metadata.
    EntityUri *string `mandatory:"false" json:"entityUri"`
}

func (WorkRequestResource) String

func (m WorkRequestResource) String() string

type WorkRequestSummary

WorkRequestSummary A summary of workrequest status.

type WorkRequestSummary struct {

    // Type of the work request.
    OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`

    // Status of current work request.
    Status OperationStatusEnum `mandatory:"true" json:"status"`

    // The ID of the work request.
    Id *string `mandatory:"true" json:"id"`

    // The ocid of the compartment that contains the work request. Work requests should be scoped to
    // the same compartment as the resource the work request affects. If the work request affects multiple resources,
    // and those resources are not in the same compartment, it is up to the service team to pick the primary
    // resource whose compartment should be used.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The resources affected by this work request.
    Resources []WorkRequestResource `mandatory:"true" json:"resources"`

    // Percentage of the request completed.
    PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

    // The date and time the request was created, as described in
    // RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
    TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

    // The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
    // section 14.29.
    TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

    // The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
    TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}

func (WorkRequestSummary) String

func (m WorkRequestSummary) String() string