Package com.oracle.bmc.operatoraccesscontrol

Class OperatorControlAssignmentClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.operatoraccesscontrol.OperatorControlAssignmentClient

All Implemented Interfaces:

OperatorControlAssignment, AutoCloseable

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for OperatorControlAssignment.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static OperatorControlAssignmentClient.Builder	builder()	Create a builder for this client.
ChangeOperatorControlAssignmentCompartmentResponse	changeOperatorControlAssignmentCompartment(ChangeOperatorControlAssignmentCompartmentRequest request)	Changes the compartment of the specified Operator Control assignment ID.
void	close()
CreateOperatorControlAssignmentResponse	createOperatorControlAssignment(CreateOperatorControlAssignmentRequest request)	Creates an Operator Control Assignment resource.
DeleteOperatorControlAssignmentResponse	deleteOperatorControlAssignment(DeleteOperatorControlAssignmentRequest request)	Deletes the specified Operator Control Assignment.
GetAssignmentValidationStatusResponse	getAssignmentValidationStatus(GetAssignmentValidationStatusRequest request)	Returns the status of assignment validation associated with the assignmentId and the executionId.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
GetOperatorControlAssignmentResponse	getOperatorControlAssignment(GetOperatorControlAssignmentRequest request)	Gets the details of an Operator Control Assignment of the specified ID.
OperatorControlAssignmentPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
OperatorControlAssignmentWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
ListOperatorControlAssignmentsResponse	listOperatorControlAssignments(ListOperatorControlAssignmentsRequest request)	Lists all Operator Control Assignments.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
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’).
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
UpdateOperatorControlAssignmentResponse	updateOperatorControlAssignment(UpdateOperatorControlAssignmentRequest request)	Modifies the existing Operator Control assignment of the specified Operator Control assignment ID.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.
ValidateOperatorAssignmentResponse	validateOperatorAssignment(ValidateOperatorAssignmentRequest request)	Validates the assignment for the specified Operator Control Assignment ID.

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 java.lang.AutoCloseable

close

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

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for OperatorControlAssignment.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

OperatorControlAssignmentClient

@Deprecated
public OperatorControlAssignmentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

OperatorControlAssignmentClient

@Deprecated
public OperatorControlAssignmentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                       ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

OperatorControlAssignmentClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

OperatorControlAssignmentClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

OperatorControlAssignmentClient

@Deprecated
public OperatorControlAssignmentClient(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 OperatorControlAssignmentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

OperatorControlAssignmentClient

@Deprecated
public OperatorControlAssignmentClient(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 OperatorControlAssignmentClient.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)

OperatorControlAssignmentClient

@Deprecated
public OperatorControlAssignmentClient(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 OperatorControlAssignmentClient.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

OperatorControlAssignmentClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OperatorControlAssignmentClient.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

executorService - OperatorControlAssignmentClient.Builder.executorService

Method Detail

builder

public static OperatorControlAssignmentClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: OperatorControlAssignment

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 OperatorControlAssignment

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: OperatorControlAssignment

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 OperatorControlAssignment

Parameters:

regionId - The public region ID.

changeOperatorControlAssignmentCompartment

public ChangeOperatorControlAssignmentCompartmentResponse changeOperatorControlAssignmentCompartment(ChangeOperatorControlAssignmentCompartmentRequest request)

Description copied from interface: OperatorControlAssignment

Changes the compartment of the specified Operator Control assignment ID.

Specified by:

changeOperatorControlAssignmentCompartment in interface OperatorControlAssignment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createOperatorControlAssignment

public CreateOperatorControlAssignmentResponse createOperatorControlAssignment(CreateOperatorControlAssignmentRequest request)

Description copied from interface: OperatorControlAssignment

Creates an Operator Control Assignment resource.

In effect, this brings the target resource under the governance of the Operator Control for specified time duration.

Specified by:

createOperatorControlAssignment in interface OperatorControlAssignment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteOperatorControlAssignment

public DeleteOperatorControlAssignmentResponse deleteOperatorControlAssignment(DeleteOperatorControlAssignmentRequest request)

Description copied from interface: OperatorControlAssignment

Deletes the specified Operator Control Assignment.

This has the effect of unassigning the specific Operator Control from the target resource.

Specified by:

deleteOperatorControlAssignment in interface OperatorControlAssignment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAssignmentValidationStatus

public GetAssignmentValidationStatusResponse getAssignmentValidationStatus(GetAssignmentValidationStatusRequest request)

Description copied from interface: OperatorControlAssignment

Returns the status of assignment validation associated with the assignmentId and the executionId.

Specified by:

getAssignmentValidationStatus in interface OperatorControlAssignment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getOperatorControlAssignment

public GetOperatorControlAssignmentResponse getOperatorControlAssignment(GetOperatorControlAssignmentRequest request)

Description copied from interface: OperatorControlAssignment

Gets the details of an Operator Control Assignment of the specified ID.

Specified by:

getOperatorControlAssignment in interface OperatorControlAssignment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOperatorControlAssignments

public ListOperatorControlAssignmentsResponse listOperatorControlAssignments(ListOperatorControlAssignmentsRequest request)

Description copied from interface: OperatorControlAssignment

Lists all Operator Control Assignments.

Specified by:

listOperatorControlAssignments in interface OperatorControlAssignment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateOperatorControlAssignment

public UpdateOperatorControlAssignmentResponse updateOperatorControlAssignment(UpdateOperatorControlAssignmentRequest request)

Description copied from interface: OperatorControlAssignment

Modifies the existing Operator Control assignment of the specified Operator Control assignment ID.

Modifying the assignment does not change the Operator Control assignment ID.

Specified by:

updateOperatorControlAssignment in interface OperatorControlAssignment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

validateOperatorAssignment

public ValidateOperatorAssignmentResponse validateOperatorAssignment(ValidateOperatorAssignmentRequest request)

Description copied from interface: OperatorControlAssignment

Validates the assignment for the specified Operator Control Assignment ID.

Specified by:

validateOperatorAssignment in interface OperatorControlAssignment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public OperatorControlAssignmentWaiters getWaiters()

Description copied from interface: OperatorControlAssignment

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

Specified by:

getWaiters in interface OperatorControlAssignment

Returns:

The service waiters.

getPaginators

public OperatorControlAssignmentPaginators getPaginators()

Description copied from interface: OperatorControlAssignment

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 OperatorControlAssignment

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template.

The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only.

This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

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

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()