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 classOperatorControlAssignmentClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for OperatorControlAssignment.
-
Constructor Summary
Constructors Constructor Description OperatorControlAssignmentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.OperatorControlAssignmentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.OperatorControlAssignmentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.OperatorControlAssignmentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.OperatorControlAssignmentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.OperatorControlAssignmentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.OperatorControlAssignmentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.OperatorControlAssignmentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static OperatorControlAssignmentClient.Builderbuilder()Create a builder for this client.ChangeOperatorControlAssignmentCompartmentResponsechangeOperatorControlAssignmentCompartment(ChangeOperatorControlAssignmentCompartmentRequest request)Changes the compartment of the specified Operator Control assignment ID.voidclose()CreateOperatorControlAssignmentResponsecreateOperatorControlAssignment(CreateOperatorControlAssignmentRequest request)Creates an Operator Control Assignment resource.DeleteOperatorControlAssignmentResponsedeleteOperatorControlAssignment(DeleteOperatorControlAssignmentRequest request)Deletes the specified Operator Control Assignment.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.GetAssignmentValidationStatusResponsegetAssignmentValidationStatus(GetAssignmentValidationStatusRequest request)Returns the status of assignment validation associated with the assignmentId and the executionId.StringgetClientCommonLibraryVersion()protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Get the endpoint of the client.Optional<String>getMinimumClientCommonLibraryVersionFromClient()GetOperatorControlAssignmentResponsegetOperatorControlAssignment(GetOperatorControlAssignmentRequest request)Gets the details of an Operator Control Assignment of the specified ID.Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.OperatorControlAssignmentPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.StringgetResolvedEndpoint(Map<String,Object> requiredParametersMap)Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.OperatorControlAssignmentWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.ListOperatorControlAssignmentsResponselistOperatorControlAssignments(ListOperatorControlAssignmentsRequest request)Lists all Operator Control Assignments.voidrefreshClient()Rebuild the backingHttpClient.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).UpdateOperatorControlAssignmentResponseupdateOperatorControlAssignment(UpdateOperatorControlAssignmentRequest request)Modifies the existing Operator Control assignment of the specified Operator Control assignment ID.voiduseRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)This method should be used to enable or disable the use of realm-specific endpoint template.ValidateOperatorAssignmentResponsevalidateOperatorAssignment(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
-
-
-
-
Constructor Detail
-
OperatorControlAssignmentClient
@Deprecated public OperatorControlAssignmentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeOperatorControlAssignmentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
OperatorControlAssignmentClient
@Deprecated public OperatorControlAssignmentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeOperatorControlAssignmentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
OperatorControlAssignmentClient
@Deprecated public OperatorControlAssignmentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeOperatorControlAssignmentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
OperatorControlAssignmentClient
@Deprecated public OperatorControlAssignmentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeOperatorControlAssignmentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeOperatorControlAssignmentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
OperatorControlAssignmentClient
@Deprecated public OperatorControlAssignmentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeOperatorControlAssignmentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeOperatorControlAssignmentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeOperatorControlAssignmentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactoriesexecutorService-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:OperatorControlAssignmentSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceOperatorControlAssignment- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:OperatorControlAssignmentSets 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 callsetEndpoint.- Specified by:
setRegionin interfaceOperatorControlAssignment- Parameters:
regionId- The public region ID.
-
changeOperatorControlAssignmentCompartment
public ChangeOperatorControlAssignmentCompartmentResponse changeOperatorControlAssignmentCompartment(ChangeOperatorControlAssignmentCompartmentRequest request)
Description copied from interface:OperatorControlAssignmentChanges the compartment of the specified Operator Control assignment ID.- Specified by:
changeOperatorControlAssignmentCompartmentin interfaceOperatorControlAssignment- 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:OperatorControlAssignmentCreates 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:
createOperatorControlAssignmentin interfaceOperatorControlAssignment- 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:OperatorControlAssignmentDeletes the specified Operator Control Assignment.This has the effect of unassigning the specific Operator Control from the target resource.
- Specified by:
deleteOperatorControlAssignmentin interfaceOperatorControlAssignment- 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:OperatorControlAssignmentReturns the status of assignment validation associated with the assignmentId and the executionId.- Specified by:
getAssignmentValidationStatusin interfaceOperatorControlAssignment- 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:OperatorControlAssignmentGets the details of an Operator Control Assignment of the specified ID.- Specified by:
getOperatorControlAssignmentin interfaceOperatorControlAssignment- 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:OperatorControlAssignmentLists all Operator Control Assignments.- Specified by:
listOperatorControlAssignmentsin interfaceOperatorControlAssignment- 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:OperatorControlAssignmentModifies 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:
updateOperatorControlAssignmentin interfaceOperatorControlAssignment- 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:OperatorControlAssignmentValidates the assignment for the specified Operator Control Assignment ID.- Specified by:
validateOperatorAssignmentin interfaceOperatorControlAssignment- 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:OperatorControlAssignmentGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceOperatorControlAssignment- Returns:
- The service waiters.
-
getPaginators
public OperatorControlAssignmentPaginators getPaginators()
Description copied from interface:OperatorControlAssignmentGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin interfaceOperatorControlAssignment- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.- Parameters:
requiredParametersMap- the map from required parameter name to their values- Returns:
- resolved endpoint, with all options and placeholders filled in
-
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
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
Get the endpoint of the client.Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a
Region.Examples of endpoints this may return:
- Unparameterized endpoints
https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with placeholders
https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with options
https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com - Parameterized endpoints with placeholders and options
https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
To get the actual endpoint for a parameterized request, you can use
BaseClient.getResolvedEndpoint(Map)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-