com.oracle.bmc.tenantmanagercontrolplane

Class LinkClient

java.lang.Object

com.oracle.bmc.tenantmanagercontrolplane.LinkClient

All Implemented Interfaces:

Link, AutoCloseable

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	LinkClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Creates a new service instance using the given authentication provider and client configuration.
	LinkClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Creates a new service instance using the given authentication provider and client configuration.
	LinkClient(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.
	LinkClient(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.
	LinkClient(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	LinkClient(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.
	LinkClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Creates a new service instance using the given authentication provider.
	LinkClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Creates a new service instance using the given authentication provider and client configuration.
	LinkClient(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 LinkClient.Builder	builder() Create a builder for this client.
void	close()
DeleteLinkResponse	deleteLink(DeleteLinkRequest request) Starts the link termination workflow.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
GetLinkResponse	getLink(GetLinkRequest request) Gets information about the link.
LinkPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
LinkWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListLinksResponse	listLinks(ListLinksRequest request) Return a (paginated) list of links.
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’).

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

Constructor Detail

LinkClient

public LinkClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

LinkClient

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

LinkClient

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

LinkClient

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

LinkClient

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

LinkClient

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

LinkClient

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

LinkClient

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

LinkClient

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

Create a builder for this client.

Returns:

builder

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: Link

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

Specified by:

setEndpoint in interface Link

Parameters:

endpoint - The endpoint of the service.

getEndpoint

public String getEndpoint()

Description copied from interface: Link

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

Specified by:

getEndpoint in interface Link

setRegion

public void setRegion(Region region)

Description copied from interface: Link

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 Link

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Link

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 Link

Parameters:

regionId - The public region ID.

close

public void close()

Specified by:

close in interface AutoCloseable

deleteLink

public DeleteLinkResponse deleteLink(DeleteLinkRequest request)

Description copied from interface: Link

Starts the link termination workflow.

Specified by:

deleteLink in interface Link

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getLink

public GetLinkResponse getLink(GetLinkRequest request)

Description copied from interface: Link

Gets information about the link.

Specified by:

getLink in interface Link

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listLinks

public ListLinksResponse listLinks(ListLinksRequest request)

Description copied from interface: Link

Return a (paginated) list of links.

Specified by:

listLinks in interface Link

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public LinkWaiters getWaiters()

Description copied from interface: Link

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

Specified by:

getWaiters in interface Link

Returns:

The service waiters.

getPaginators

public LinkPaginators getPaginators()

Description copied from interface: Link

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 Link

Returns:

The service paginators.