com.oracle.bmc.operatoraccesscontrol

Class OperatorActionsClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.operatoraccesscontrol.OperatorActionsClient

All Implemented Interfaces:

OperatorActions, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200630")
public class OperatorActionsClient
extends BaseSyncClient
implements OperatorActions

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
OperatorActionsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
OperatorActionsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
OperatorActionsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
OperatorActionsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
OperatorActionsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
OperatorActionsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
OperatorActionsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static OperatorActionsClient.Builder	builder() Create a builder for this client.
void	close()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
GetOperatorActionResponse	getOperatorAction(GetOperatorActionRequest request) Gets the operator action associated with the specified operator action ID.
OperatorActionsPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
ListOperatorActionsResponse	listOperatorActions(ListOperatorActionsRequest request) Lists all the OperatorActions available in the system.
void	refreshClient() Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
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 com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.bmc.operatoraccesscontrol.OperatorActions

getEndpoint, refreshClient, setEndpoint

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for OperatorActions.

Constructor Detail

OperatorActionsClient

@Deprecated
public OperatorActionsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OperatorActionsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

OperatorActionsClient

@Deprecated
public OperatorActionsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OperatorActionsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

OperatorActionsClient

@Deprecated
public OperatorActionsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OperatorActionsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

OperatorActionsClient

@Deprecated
public OperatorActionsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OperatorActionsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

OperatorActionsClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OperatorActionsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

OperatorActionsClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OperatorActionsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

OperatorActionsClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OperatorActionsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

Method Detail

builder

public static OperatorActionsClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: OperatorActions

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 OperatorActions

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: OperatorActions

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 OperatorActions

Parameters:

regionId - The public region ID.

getOperatorAction

public GetOperatorActionResponse getOperatorAction(GetOperatorActionRequest request)

Description copied from interface: OperatorActions

Gets the operator action associated with the specified operator action ID.

Specified by:

getOperatorAction in interface OperatorActions

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOperatorActions

public ListOperatorActionsResponse listOperatorActions(ListOperatorActionsRequest request)

Description copied from interface: OperatorActions

Lists all the OperatorActions available in the system.

Specified by:

listOperatorActions in interface OperatorActions

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPaginators

public OperatorActionsPaginators getPaginators()

Description copied from interface: OperatorActions

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 OperatorActions

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable