@Generated(value="OracleSDKGenerator", comments="API Version: 20200630") public class OperatorControlClient extends Object implements OperatorControl
Modifier and Type | Class and Description |
---|---|
static class |
OperatorControlClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for OperatorControl.
|
Modifier | Constructor and Description |
---|---|
|
OperatorControlClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
|
OperatorControlClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
|
OperatorControlClient(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.
|
|
OperatorControlClient(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.
|
|
OperatorControlClient(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 |
OperatorControlClient(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.
|
|
OperatorControlClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
|
OperatorControlClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
|
OperatorControlClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
Modifier and Type | Method and Description |
---|---|
static OperatorControlClient.Builder |
builder()
Create a builder for this client.
|
ChangeOperatorControlCompartmentResponse |
changeOperatorControlCompartment(ChangeOperatorControlCompartmentRequest request)
Moves the Operator Control resource into a different compartment.
|
void |
close() |
CreateOperatorControlResponse |
createOperatorControl(CreateOperatorControlRequest request)
Creates an Operator Control.
|
DeleteOperatorControlResponse |
deleteOperatorControl(DeleteOperatorControlRequest request)
Deletes an Operator Control.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
GetOperatorControlResponse |
getOperatorControl(GetOperatorControlRequest request)
Gets the Operator Control associated with the specified Operator Control ID.
|
OperatorControlPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple
pages of data.
|
OperatorControlWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
ListOperatorControlsResponse |
listOperatorControls(ListOperatorControlsRequest request)
Lists the operator controls in the compartment.
|
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’).
|
UpdateOperatorControlResponse |
updateOperatorControl(UpdateOperatorControlRequest request)
Modifies the existing OperatorControl for a given operator control id except the operator control id.
|
public static final Service SERVICE
Service instance for OperatorControl.
public OperatorControlClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public OperatorControlClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public OperatorControlClient(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.
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.public OperatorControlClient(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.
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.public OperatorControlClient(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.
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.public OperatorControlClient(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.
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
)public OperatorControlClient(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.
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 signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public OperatorControlClient(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.
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 signeradditionalClientConfigurators
- 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 ThreadPoolExecutorprotected OperatorControlClient(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 OperatorControlClient.Builder
to get access to all these 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 signeradditionalClientConfigurators
- 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 ThreadPoolExecutorrestClientFactoryBuilder
- the builder for the RestClientFactory
public static OperatorControlClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
OperatorControl
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface OperatorControl
endpoint
- The endpoint of the service.public String getEndpoint()
OperatorControl
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface OperatorControl
public void setRegion(Region region)
OperatorControl
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.
setRegion
in interface OperatorControl
region
- The region of the service.public void setRegion(String regionId)
OperatorControl
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
.
setRegion
in interface OperatorControl
regionId
- The public region ID.public void close()
close
in interface AutoCloseable
public ChangeOperatorControlCompartmentResponse changeOperatorControlCompartment(ChangeOperatorControlCompartmentRequest request)
OperatorControl
Moves the Operator Control resource into a different compartment. When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource.
changeOperatorControlCompartment
in interface OperatorControl
request
- The request object containing the details to sendpublic CreateOperatorControlResponse createOperatorControl(CreateOperatorControlRequest request)
OperatorControl
Creates an Operator Control.
createOperatorControl
in interface OperatorControl
request
- The request object containing the details to sendpublic DeleteOperatorControlResponse deleteOperatorControl(DeleteOperatorControlRequest request)
OperatorControl
Deletes an Operator Control. You cannot delete an Operator Control if it is assigned to govern any target resource currently or in the future. In that case, first, delete all of the current and future assignments before deleting the Operator Control. An Operator Control that was previously assigned to a target resource is marked as DELETED following a successful deletion. However, it is not completely deleted from the system. This is to ensure auditing information for the accesses done under the Operator Control is preserved for future needs. The system purges the deleted Operator Control only when all of the audit data associated with the Operator Control are also deleted. Therefore, you cannot reuse the name of the deleted Operator Control until the system purges the Operator Control.
deleteOperatorControl
in interface OperatorControl
request
- The request object containing the details to sendpublic GetOperatorControlResponse getOperatorControl(GetOperatorControlRequest request)
OperatorControl
Gets the Operator Control associated with the specified Operator Control ID.
getOperatorControl
in interface OperatorControl
request
- The request object containing the details to sendpublic ListOperatorControlsResponse listOperatorControls(ListOperatorControlsRequest request)
OperatorControl
Lists the operator controls in the compartment.
listOperatorControls
in interface OperatorControl
request
- The request object containing the details to sendpublic UpdateOperatorControlResponse updateOperatorControl(UpdateOperatorControlRequest request)
OperatorControl
Modifies the existing OperatorControl for a given operator control id except the operator control id.
updateOperatorControl
in interface OperatorControl
request
- The request object containing the details to sendpublic OperatorControlWaiters getWaiters()
OperatorControl
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface OperatorControl
public OperatorControlPaginators getPaginators()
OperatorControl
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.
getPaginators
in interface OperatorControl
Copyright © 2016–2022. All rights reserved.