com.oracle.bmc.tenantmanagercontrolplane

Class SenderInvitationClient

java.lang.Object

com.oracle.bmc.tenantmanagercontrolplane.SenderInvitationClient

All Implemented Interfaces:

SenderInvitation, AutoCloseable

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	SenderInvitationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Creates a new service instance using the given authentication provider and client configuration.
	SenderInvitationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Creates a new service instance using the given authentication provider and client configuration.
	SenderInvitationClient(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.
	SenderInvitationClient(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.
	SenderInvitationClient(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	SenderInvitationClient(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.
	SenderInvitationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Creates a new service instance using the given authentication provider.
	SenderInvitationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Creates a new service instance using the given authentication provider and client configuration.
	SenderInvitationClient(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
static SenderInvitationClient.Builder	builder() Create a builder for this client.
CancelSenderInvitationResponse	cancelSenderInvitation(CancelSenderInvitationRequest request) Cancels a sender invitation.
void	close()
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 SenderInvitation.

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 SenderInvitation.

Constructor Detail

SenderInvitationClient

public SenderInvitationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

SenderInvitationClient

public SenderInvitationClient(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.

SenderInvitationClient

public SenderInvitationClient(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.

SenderInvitationClient

public SenderInvitationClient(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.

SenderInvitationClient

public SenderInvitationClient(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.

SenderInvitationClient

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

SenderInvitationClient

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

SenderInvitationClient

public SenderInvitationClient(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

SenderInvitationClient

protected SenderInvitationClient(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 SenderInvitationClient.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 SenderInvitationClient.Builder builder()

Create a builder for this client.

Returns:

builder

refreshClient

public void refreshClient()

Description copied from interface: SenderInvitation

Rebuilds the client from scratch. Useful to refresh certificates.

Specified by:

refreshClient in interface SenderInvitation

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: SenderInvitation

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

Specified by:

setEndpoint in interface SenderInvitation

Parameters:

endpoint - The endpoint of the service.

getEndpoint

public String getEndpoint()

Description copied from interface: SenderInvitation

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

Specified by:

getEndpoint in interface SenderInvitation

setRegion

public void setRegion(Region region)

Description copied from interface: SenderInvitation

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 SenderInvitation

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: SenderInvitation

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 SenderInvitation

Parameters:

regionId - The public region ID.

close

public void close()

Specified by:

close in interface AutoCloseable

cancelSenderInvitation

public CancelSenderInvitationResponse cancelSenderInvitation(CancelSenderInvitationRequest request)

Description copied from interface: SenderInvitation

Cancels a sender invitation.

Specified by:

cancelSenderInvitation in interface SenderInvitation

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createSenderInvitation

public CreateSenderInvitationResponse createSenderInvitation(CreateSenderInvitationRequest request)

Description copied from interface: SenderInvitation

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

Specified by:

createSenderInvitation in interface SenderInvitation

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getSenderInvitation

public GetSenderInvitationResponse getSenderInvitation(GetSenderInvitationRequest request)

Description copied from interface: SenderInvitation

Gets information about the sender invitation.

Specified by:

getSenderInvitation in interface SenderInvitation

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listSenderInvitations

public ListSenderInvitationsResponse listSenderInvitations(ListSenderInvitationsRequest request)

Description copied from interface: SenderInvitation

Return a (paginated) list of sender invitations.

Specified by:

listSenderInvitations in interface SenderInvitation

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateSenderInvitation

public UpdateSenderInvitationResponse updateSenderInvitation(UpdateSenderInvitationRequest request)

Description copied from interface: SenderInvitation

Updates the SenderInvitation.

Specified by:

updateSenderInvitation in interface SenderInvitation

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public SenderInvitationWaiters getWaiters()

Description copied from interface: SenderInvitation

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

Specified by:

getWaiters in interface SenderInvitation

Returns:

The service waiters.

getPaginators

public SenderInvitationPaginators getPaginators()

Description copied from interface: SenderInvitation

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 SenderInvitation

Returns:

The service paginators.