com.oracle.bmc.operatoraccesscontrol

Class AccessRequestsClient

java.lang.Object

com.oracle.bmc.operatoraccesscontrol.AccessRequestsClient

All Implemented Interfaces:

AccessRequests, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200630")
public class AccessRequestsClient
extends Object
implements AccessRequests

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	AccessRequestsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Creates a new service instance using the given authentication provider and client configuration.
	AccessRequestsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Creates a new service instance using the given authentication provider and client configuration.
	AccessRequestsClient(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.
	AccessRequestsClient(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.
	AccessRequestsClient(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	AccessRequestsClient(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.
	AccessRequestsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Creates a new service instance using the given authentication provider.
	AccessRequestsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Creates a new service instance using the given authentication provider and client configuration.
	AccessRequestsClient(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
ApproveAccessRequestResponse	approveAccessRequest(ApproveAccessRequestRequest request) Approves an access request.
static AccessRequestsClient.Builder	builder() Create a builder for this client.
void	close()
GetAccessRequestResponse	getAccessRequest(GetAccessRequestRequest request) Gets details of an access request.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
AccessRequestsPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
AccessRequestsWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListAccessRequestHistoriesResponse	listAccessRequestHistories(ListAccessRequestHistoriesRequest request) Returns a history of all status associated with the accessRequestId.
ListAccessRequestsResponse	listAccessRequests(ListAccessRequestsRequest request) Lists all access requests in the compartment.
RejectAccessRequestResponse	rejectAccessRequest(RejectAccessRequestRequest request) Rejects an access request.
ReviewAccessRequestResponse	reviewAccessRequest(ReviewAccessRequestRequest request) Reviews the access request.
RevokeAccessRequestResponse	revokeAccessRequest(RevokeAccessRequestRequest request) Revokes an already approved access request.
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 AccessRequests.

Constructor Detail

AccessRequestsClient

public AccessRequestsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

AccessRequestsClient

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

AccessRequestsClient

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

AccessRequestsClient

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

AccessRequestsClient

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

AccessRequestsClient

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

AccessRequestsClient

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

AccessRequestsClient

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

AccessRequestsClient

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

Create a builder for this client.

Returns:

builder

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: AccessRequests

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

Specified by:

setEndpoint in interface AccessRequests

Parameters:

endpoint - The endpoint of the service.

getEndpoint

public String getEndpoint()

Description copied from interface: AccessRequests

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

Specified by:

getEndpoint in interface AccessRequests

setRegion

public void setRegion(Region region)

Description copied from interface: AccessRequests

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 AccessRequests

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: AccessRequests

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 AccessRequests

Parameters:

regionId - The public region ID.

close

public void close()

Specified by:

close in interface AutoCloseable

approveAccessRequest

public ApproveAccessRequestResponse approveAccessRequest(ApproveAccessRequestRequest request)

Description copied from interface: AccessRequests

Approves an access request.

Specified by:

approveAccessRequest in interface AccessRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAccessRequest

public GetAccessRequestResponse getAccessRequest(GetAccessRequestRequest request)

Description copied from interface: AccessRequests

Gets details of an access request.

Specified by:

getAccessRequest in interface AccessRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAccessRequestHistories

public ListAccessRequestHistoriesResponse listAccessRequestHistories(ListAccessRequestHistoriesRequest request)

Description copied from interface: AccessRequests

Returns a history of all status associated with the accessRequestId.

Specified by:

listAccessRequestHistories in interface AccessRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAccessRequests

public ListAccessRequestsResponse listAccessRequests(ListAccessRequestsRequest request)

Description copied from interface: AccessRequests

Lists all access requests in the compartment.

Specified by:

listAccessRequests in interface AccessRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

rejectAccessRequest

public RejectAccessRequestResponse rejectAccessRequest(RejectAccessRequestRequest request)

Description copied from interface: AccessRequests

Rejects an access request.

Specified by:

rejectAccessRequest in interface AccessRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

reviewAccessRequest

public ReviewAccessRequestResponse reviewAccessRequest(ReviewAccessRequestRequest request)

Description copied from interface: AccessRequests

Reviews the access request.

Specified by:

reviewAccessRequest in interface AccessRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

revokeAccessRequest

public RevokeAccessRequestResponse revokeAccessRequest(RevokeAccessRequestRequest request)

Description copied from interface: AccessRequests

Revokes an already approved access request.

Specified by:

revokeAccessRequest in interface AccessRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public AccessRequestsWaiters getWaiters()

Description copied from interface: AccessRequests

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

Specified by:

getWaiters in interface AccessRequests

Returns:

The service waiters.

getPaginators

public AccessRequestsPaginators getPaginators()

Description copied from interface: AccessRequests

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 AccessRequests

Returns:

The service paginators.