com.oracle.bmc.tenantmanagercontrolplane

Interface SenderInvitation

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

SenderInvitationClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20230401")
public interface SenderInvitation
extends AutoCloseable

Use the Organizations API to consolidate multiple OCI tenancies into an organization, and centrally manage your tenancies and organization resources. For more information, see Organization Management Overview. This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

Modifier and Type	Method and Description
CancelSenderInvitationResponse	cancelSenderInvitation(CancelSenderInvitationRequest request) Cancels a sender invitation.
CreateSenderInvitationResponse	createSenderInvitation(CreateSenderInvitationRequest request) Creates a sender invitation and asynchronously sends the invitation to the recipient.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
SenderInvitationPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetSenderInvitationResponse	getSenderInvitation(GetSenderInvitationRequest request) Gets information about the sender invitation.
SenderInvitationWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListSenderInvitationsResponse	listSenderInvitations(ListSenderInvitationsRequest request) Return a (paginated) list of sender invitations.
void	refreshClient() Rebuilds the client from scratch.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
UpdateSenderInvitationResponse	updateSenderInvitation(UpdateSenderInvitationRequest request) Updates the sender invitation.
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

refreshClient

void refreshClient()

Rebuilds the client from scratch. Useful to refresh certificates.

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the service.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Parameters:

regionId - The public region ID.

useRealmSpecificEndpointTemplate

void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)

Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

Parameters:

realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

cancelSenderInvitation

CancelSenderInvitationResponse cancelSenderInvitation(CancelSenderInvitationRequest request)

Cancels a sender invitation.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use CancelSenderInvitation API.

createSenderInvitation

CreateSenderInvitationResponse createSenderInvitation(CreateSenderInvitationRequest request)

Creates a sender invitation and asynchronously sends the invitation to the recipient.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use CreateSenderInvitation API.

getSenderInvitation

GetSenderInvitationResponse getSenderInvitation(GetSenderInvitationRequest request)

Gets information about the sender invitation.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetSenderInvitation API.

listSenderInvitations

ListSenderInvitationsResponse listSenderInvitations(ListSenderInvitationsRequest request)

Return a (paginated) list of sender invitations.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListSenderInvitations API.

updateSenderInvitation

UpdateSenderInvitationResponse updateSenderInvitation(UpdateSenderInvitationRequest request)

Updates the sender invitation.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use UpdateSenderInvitation API.

getWaiters

SenderInvitationWaiters getWaiters()

Gets the pre-configured waiters available for resources for this service.

Returns:

The service waiters.

getPaginators

SenderInvitationPaginators getPaginators()

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Returns:

The service paginators.