com.oracle.bmc.tenantmanagercontrolplane

Class RecipientInvitationClient

java.lang.Object

com.oracle.bmc.tenantmanagercontrolplane.RecipientInvitationClient

All Implemented Interfaces:

RecipientInvitation, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200801")
public class RecipientInvitationClient
extends Object
implements RecipientInvitation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecipientInvitationClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for RecipientInvitation.

Constructor Summary

Constructors

Modifier	Constructor and Description
	RecipientInvitationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Creates a new service instance using the given authentication provider and client configuration.
	RecipientInvitationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Creates a new service instance using the given authentication provider and client configuration.
	RecipientInvitationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Creates a new service instance using the given authentication provider and client configuration.
	RecipientInvitationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Creates a new service instance using the given authentication provider and client configuration.
	RecipientInvitationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Creates a new service instance using the given authentication provider and client configuration.
protected	RecipientInvitationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, RestClientFactoryBuilder restClientFactoryBuilder) Creates a new service instance using the given authentication provider and client configuration.
	RecipientInvitationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Creates a new service instance using the given authentication provider.
	RecipientInvitationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Creates a new service instance using the given authentication provider and client configuration.
	RecipientInvitationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Creates a new service instance using the given authentication provider and client configuration.

Method Summary

Modifier and Type	Method and Description
AcceptRecipientInvitationResponse	acceptRecipientInvitation(AcceptRecipientInvitationRequest request) Accepts a recipient invitation.
static RecipientInvitationClient.Builder	builder() Create a builder for this client.
void	close()
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
RecipientInvitationPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetRecipientInvitationResponse	getRecipientInvitation(GetRecipientInvitationRequest request) Gets information about the recipient invitation.
RecipientInvitationWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
IgnoreRecipientInvitationResponse	ignoreRecipientInvitation(IgnoreRecipientInvitationRequest request) Ignores a recipient invitation.
ListRecipientInvitationsResponse	listRecipientInvitations(ListRecipientInvitationsRequest request) Return a (paginated) list of recipient 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’).
UpdateRecipientInvitationResponse	updateRecipientInvitation(UpdateRecipientInvitationRequest request) Updates the RecipientInvitation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SERVICE

public static final Service SERVICE

Service instance for RecipientInvitation.

Constructor Detail

RecipientInvitationClient

public RecipientInvitationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

RecipientInvitationClient

public RecipientInvitationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration)

Creates a new service instance using the given authentication provider and client configuration.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

RecipientInvitationClient

public RecipientInvitationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

RecipientInvitationClient

public RecipientInvitationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator,
                                 RequestSignerFactory defaultRequestSignerFactory)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

RecipientInvitationClient

public RecipientInvitationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator,
                                 RequestSignerFactory defaultRequestSignerFactory,
                                 List<ClientConfigurator> additionalClientConfigurators)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

RecipientInvitationClient

public RecipientInvitationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator,
                                 RequestSignerFactory defaultRequestSignerFactory,
                                 List<ClientConfigurator> additionalClientConfigurators,
                                 String endpoint)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

RecipientInvitationClient

public RecipientInvitationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator,
                                 RequestSignerFactory defaultRequestSignerFactory,
                                 Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                 List<ClientConfigurator> additionalClientConfigurators,
                                 String endpoint)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

RecipientInvitationClient

public RecipientInvitationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator,
                                 RequestSignerFactory defaultRequestSignerFactory,
                                 Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                 List<ClientConfigurator> additionalClientConfigurators,
                                 String endpoint,
                                 ExecutorService executorService)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor

RecipientInvitationClient

protected RecipientInvitationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                    List<ClientConfigurator> additionalClientConfigurators,
                                    String endpoint,
                                    ExecutorService executorService,
                                    RestClientFactoryBuilder restClientFactoryBuilder)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed. Use the RecipientInvitationClient.Builder to get access to all these parameters.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor

restClientFactoryBuilder - the builder for the RestClientFactory

Method Detail

builder

public static RecipientInvitationClient.Builder builder()

Create a builder for this client.

Returns:

builder

refreshClient

public void refreshClient()

Description copied from interface: RecipientInvitation

Rebuilds the client from scratch. Useful to refresh certificates.

Specified by:

refreshClient in interface RecipientInvitation

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: RecipientInvitation

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

Specified by:

setEndpoint in interface RecipientInvitation

Parameters:

endpoint - The endpoint of the service.

getEndpoint

public String getEndpoint()

Description copied from interface: RecipientInvitation

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

Specified by:

getEndpoint in interface RecipientInvitation

setRegion

public void setRegion(Region region)

Description copied from interface: RecipientInvitation

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.

Specified by:

setRegion in interface RecipientInvitation

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: RecipientInvitation

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.

Specified by:

setRegion in interface RecipientInvitation

Parameters:

regionId - The public region ID.

close

public void close()

Specified by:

close in interface AutoCloseable

acceptRecipientInvitation

public AcceptRecipientInvitationResponse acceptRecipientInvitation(AcceptRecipientInvitationRequest request)

Description copied from interface: RecipientInvitation

Accepts a recipient invitation.

Specified by:

acceptRecipientInvitation in interface RecipientInvitation

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getRecipientInvitation

public GetRecipientInvitationResponse getRecipientInvitation(GetRecipientInvitationRequest request)

Description copied from interface: RecipientInvitation

Gets information about the recipient invitation.

Specified by:

getRecipientInvitation in interface RecipientInvitation

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

ignoreRecipientInvitation

public IgnoreRecipientInvitationResponse ignoreRecipientInvitation(IgnoreRecipientInvitationRequest request)

Description copied from interface: RecipientInvitation

Ignores a recipient invitation.

Specified by:

ignoreRecipientInvitation in interface RecipientInvitation

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listRecipientInvitations

public ListRecipientInvitationsResponse listRecipientInvitations(ListRecipientInvitationsRequest request)

Description copied from interface: RecipientInvitation

Return a (paginated) list of recipient invitations.

Specified by:

listRecipientInvitations in interface RecipientInvitation

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateRecipientInvitation

public UpdateRecipientInvitationResponse updateRecipientInvitation(UpdateRecipientInvitationRequest request)

Description copied from interface: RecipientInvitation

Updates the RecipientInvitation.

Specified by:

updateRecipientInvitation in interface RecipientInvitation

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public RecipientInvitationWaiters getWaiters()

Description copied from interface: RecipientInvitation

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

Specified by:

getWaiters in interface RecipientInvitation

Returns:

The service waiters.

getPaginators

public RecipientInvitationPaginators getPaginators()

Description copied from interface: RecipientInvitation

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.

Specified by:

getPaginators in interface RecipientInvitation

Returns:

The service paginators.