Class SecurityAttributeClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.securityattribute.SecurityAttributeClient
-
- All Implemented Interfaces:
SecurityAttribute
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20240815") public class SecurityAttributeClient extends BaseSyncClient implements SecurityAttribute
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SecurityAttributeClient.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 SecurityAttribute.
-
Constructor Summary
Constructors Constructor Description SecurityAttributeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.SecurityAttributeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.SecurityAttributeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.SecurityAttributeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.SecurityAttributeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.SecurityAttributeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.SecurityAttributeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.SecurityAttributeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
-
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.securityattribute.SecurityAttribute
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
SecurityAttributeClient
@Deprecated public SecurityAttributeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeSecurityAttributeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
SecurityAttributeClient
@Deprecated public SecurityAttributeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeSecurityAttributeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
SecurityAttributeClient
@Deprecated public SecurityAttributeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeSecurityAttributeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
SecurityAttributeClient
@Deprecated public SecurityAttributeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeSecurityAttributeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
SecurityAttributeClient
@Deprecated public SecurityAttributeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeSecurityAttributeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
SecurityAttributeClient
@Deprecated public SecurityAttributeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeSecurityAttributeClient.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)
-
SecurityAttributeClient
@Deprecated public SecurityAttributeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeSecurityAttributeClient.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
-
SecurityAttributeClient
@Deprecated public SecurityAttributeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeSecurityAttributeClient.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
-SecurityAttributeClient.Builder.executorService
-
-
Method Detail
-
builder
public static SecurityAttributeClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:SecurityAttribute
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 interfaceSecurityAttribute
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:SecurityAttribute
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 callsetEndpoint
.- Specified by:
setRegion
in interfaceSecurityAttribute
- Parameters:
regionId
- The public region ID.
-
bulkDeleteSecurityAttributes
public BulkDeleteSecurityAttributesResponse bulkDeleteSecurityAttributes(BulkDeleteSecurityAttributesRequest request)
Description copied from interface:SecurityAttribute
Deletes the specified security attribute definitions.This operation triggers a process that removes the security attributes from all resources in your tenancy. The security attributes must be within the same security attribute namespace.
The following actions happen immediately:
After you start this operation, the state of the tag changes to DELETING, and security attribute removal from resources begins. This process can take up to 48 hours depending on the number of resources that are tagged and the regions in which those resources reside.
When all security attributes have been removed, the state changes to DELETED. You cannot restore a deleted security attribute. After the security attribute state changes to DELETED, you can use the same security attribute name again.
After you start this operation, you cannot start either the
deleteSecurityAttribute
or thecascadingDeleteSecurityAttributeNamespace
operation until this process completes.In order to delete security attribute, you must first retire the security attribute. Use
updateSecurityAttributeNamespace
to retire a security attribute.- Specified by:
bulkDeleteSecurityAttributes
in interfaceSecurityAttribute
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
bulkEditSecurityAttributes
public BulkEditSecurityAttributesResponse bulkEditSecurityAttributes(BulkEditSecurityAttributesRequest request)
Description copied from interface:SecurityAttribute
Edits the specified list of security attributes for the selected resources.This operation triggers a process that edits the attributes on all selected resources. The possible actions are:
Add a security attribute when it does not already exist on the resource. * Update the value for a security attribute when it is present on the resource. * Add a security attribute when it does not already exist on the resource or update the value when it is present on the resource. * Remove a security attribute from a resource. The security attribute is removed from the resource regardless of the value.
The edits can include a combination of operations and attributes. However, multiple operations cannot apply to the same attribute in the same request.
- Specified by:
bulkEditSecurityAttributes
in interfaceSecurityAttribute
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
cascadingDeleteSecurityAttributeNamespace
public CascadingDeleteSecurityAttributeNamespaceResponse cascadingDeleteSecurityAttributeNamespace(CascadingDeleteSecurityAttributeNamespaceRequest request)
Description copied from interface:SecurityAttribute
Deletes the specified security attribute namespace.This operation triggers a process that removes all of the security attributes defined in the specified security attribute namespace from all resources in your tenancy and then deletes the security attribute namespace.
After you start the delete operation:
New security attribute key definitions cannot be created under the namespace. * The state of the security attribute namespace changes to DELETING. * Security attribute removal from the resources begins.
This process can take up to 48 hours depending on the number of security attributes in the namespace, the number of resources that are tagged, and the locations of the regions in which those resources reside.
After all security attributes are removed, the state changes to DELETED. You cannot restore a deleted security attribute namespace. After the deleted security attribute namespace changes its state to DELETED, you can use the name of the deleted security attribute namespace again.
After you start this operation, you cannot start either the
deleteSecurityAttribute
or thebulkDeleteSecurityAttributes
operation until this process completes.To delete a security attribute namespace, you must first retire it. Use
updateSecurityAttributeNamespace
to retire a security attribute namespace.- Specified by:
cascadingDeleteSecurityAttributeNamespace
in interfaceSecurityAttribute
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeSecurityAttributeNamespaceCompartment
public ChangeSecurityAttributeNamespaceCompartmentResponse changeSecurityAttributeNamespaceCompartment(ChangeSecurityAttributeNamespaceCompartmentRequest request)
Description copied from interface:SecurityAttribute
Moves the specified security attribute namespace to the specified compartment within the same tenancy.To move the security attribute namespace, you must have the manage security-attributes permission on both compartments. For more information about IAM policies, see [Details for IAM](https://docs.oracle.com/iaas/Content/Identity/policyreference/iampolicyreference.htm).
Moving a security attribute namespace moves all the security attributes contained in the security attribute namespace.
- Specified by:
changeSecurityAttributeNamespaceCompartment
in interfaceSecurityAttribute
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createSecurityAttribute
public CreateSecurityAttributeResponse createSecurityAttribute(CreateSecurityAttributeRequest request)
Description copied from interface:SecurityAttribute
Creates a new security attribute in the specified security attribute namespace.The security attribute requires either the OCID or the name of the security attribute namespace that will contain this security attribute.
You must specify a *name* for the attribute, which must be unique across all attributes in the security attribute namespace and cannot be changed. The only valid characters for security attribute names are: 0-9, A-Z, a-z, -, _ characters. Names are case insensitive. That means, for example, \"mySecurityAttribute\" and \"mysecurityattribute\" are not allowed in the same namespace. If you specify a name that's already in use in the security attribute namespace, a 409 error is returned.
The security attribute must have a *description*. It does not have to be unique, and you can change it with
updateSecurityAttribute
.The security attribute must have a value type, which is specified with a validator. Security attribute can use either a static value or a list of possible values. Static values are entered by a user applying the security attribute to a resource. Lists are created by the user and the user must apply a value from the list. Lists are validated.
- Specified by:
createSecurityAttribute
in interfaceSecurityAttribute
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createSecurityAttributeNamespace
public CreateSecurityAttributeNamespaceResponse createSecurityAttributeNamespace(CreateSecurityAttributeNamespaceRequest request)
Description copied from interface:SecurityAttribute
Creates a new security attribute namespace in the specified compartment.You must specify the compartment ID in the request object (remember that the tenancy is simply the root compartment).
You must also specify a *name* for the namespace, which must be unique across all namespaces in your tenancy and cannot be changed. The only valid characters for security attribute names are: 0-9, A-Z, a-z, -, _ characters. Names are case insensitive. That means, for example, \"myNamespace\" and \"mynamespace\" are not allowed in the same tenancy. Once you created a namespace, you cannot change the name. If you specify a name that's already in use in the tenancy, a 409 error is returned.
You must also specify a *description* for the namespace. It does not have to be unique, and you can change it with
updateSecurityAttributeNamespace
.- Specified by:
createSecurityAttributeNamespace
in interfaceSecurityAttribute
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSecurityAttribute
public DeleteSecurityAttributeResponse deleteSecurityAttribute(DeleteSecurityAttributeRequest request)
Description copied from interface:SecurityAttribute
Deletes the specified security attribute.This operation triggers a process that removes the security attribute from all resources in your tenancy.
When you start the delete operation, the state of the security attribute changes to DELETING and security attribute removal from resources begins. This can take up to 48 hours depending on the number of resources that were tagged as well as the regions in which those resources reside.
When all attributes have been removed, the state changes to DELETED. You cannot restore a deleted attribute. Once the deleted attribute changes its state to DELETED, you can use the same security attribute name again.
After you start this operation, you cannot start either the
bulkDeleteSecurityAttributes
or thecascadingDeleteSecurityAttributeNamespace
operation until this process completes.To delete a security attribute, you must first retire it. Use
updateSecurityAttribute
to retire a security attribute.- Specified by:
deleteSecurityAttribute
in interfaceSecurityAttribute
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSecurityAttributeNamespace
public DeleteSecurityAttributeNamespaceResponse deleteSecurityAttributeNamespace(DeleteSecurityAttributeNamespaceRequest request)
Description copied from interface:SecurityAttribute
Deletes the specified security attribute namespace.Only an empty security attribute namespace can be deleted with this operation. To use this operation to delete a security attribute namespace that contains security attributes, first delete all of its security attributes. Use
deleteSecurityAttribute
to delete a security attribute.- Specified by:
deleteSecurityAttributeNamespace
in interfaceSecurityAttribute
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSecurityAttribute
public GetSecurityAttributeResponse getSecurityAttribute(GetSecurityAttributeRequest request)
Description copied from interface:SecurityAttribute
Gets the specified security attribute’s information.- Specified by:
getSecurityAttribute
in interfaceSecurityAttribute
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSecurityAttributeNamespace
public GetSecurityAttributeNamespaceResponse getSecurityAttributeNamespace(GetSecurityAttributeNamespaceRequest request)
Description copied from interface:SecurityAttribute
Gets the specified security attribute namespace’s information.- Specified by:
getSecurityAttributeNamespace
in interfaceSecurityAttribute
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSecurityAttributeWorkRequest
public GetSecurityAttributeWorkRequestResponse getSecurityAttributeWorkRequest(GetSecurityAttributeWorkRequestRequest request)
Description copied from interface:SecurityAttribute
Gets details on a specified work request.The workRequestID is returned in the opc-work-request-id header for any asynchronous operation in security attributes service.
- Specified by:
getSecurityAttributeWorkRequest
in interfaceSecurityAttribute
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSecurityAttributeNamespaces
public ListSecurityAttributeNamespacesResponse listSecurityAttributeNamespaces(ListSecurityAttributeNamespacesRequest request)
Description copied from interface:SecurityAttribute
Lists the security attribute namespaces in the specified compartment.- Specified by:
listSecurityAttributeNamespaces
in interfaceSecurityAttribute
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSecurityAttributeWorkRequestErrors
public ListSecurityAttributeWorkRequestErrorsResponse listSecurityAttributeWorkRequestErrors(ListSecurityAttributeWorkRequestErrorsRequest request)
Description copied from interface:SecurityAttribute
Gets the errors for a work request.- Specified by:
listSecurityAttributeWorkRequestErrors
in interfaceSecurityAttribute
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSecurityAttributeWorkRequestLogs
public ListSecurityAttributeWorkRequestLogsResponse listSecurityAttributeWorkRequestLogs(ListSecurityAttributeWorkRequestLogsRequest request)
Description copied from interface:SecurityAttribute
Gets the logs for a work request.- Specified by:
listSecurityAttributeWorkRequestLogs
in interfaceSecurityAttribute
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSecurityAttributeWorkRequests
public ListSecurityAttributeWorkRequestsResponse listSecurityAttributeWorkRequests(ListSecurityAttributeWorkRequestsRequest request)
Description copied from interface:SecurityAttribute
Lists the security attribute work requests in compartment.- Specified by:
listSecurityAttributeWorkRequests
in interfaceSecurityAttribute
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSecurityAttributes
public ListSecurityAttributesResponse listSecurityAttributes(ListSecurityAttributesRequest request)
Description copied from interface:SecurityAttribute
Lists the security attributes in the specified namespace.- Specified by:
listSecurityAttributes
in interfaceSecurityAttribute
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSecurityAttribute
public UpdateSecurityAttributeResponse updateSecurityAttribute(UpdateSecurityAttributeRequest request)
Description copied from interface:SecurityAttribute
Updates the specified security attribute.You can only update
description
, andisRetired
.- Specified by:
updateSecurityAttribute
in interfaceSecurityAttribute
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSecurityAttributeNamespace
public UpdateSecurityAttributeNamespaceResponse updateSecurityAttributeNamespace(UpdateSecurityAttributeNamespaceRequest request)
Description copied from interface:SecurityAttribute
Updates the specified security attribute namespace.You can’t update the namespace name.
Updating `isRetired` to 'true' retires the namespace and all the security attributes in the namespace. Reactivating a namespace (changing `isRetired` from 'true' to 'false') does not reactivate security attributes. To reactivate the security attributes, you must reactivate each one individually *after* you reactivate the namespace, using
updateSecurityAttribute
. For more information about retiring security attribute namespaces, see [Managing Security Attribute Namespaces](https://docs.oracle.com/iaas/Content/zero-trust-packet-routing/managing-security-attribute-namespaces.htm).You can't add a namespace with the same name as a retired namespace in the same tenancy.
- Specified by:
updateSecurityAttributeNamespace
in interfaceSecurityAttribute
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public SecurityAttributeWaiters getWaiters()
Description copied from interface:SecurityAttribute
Gets the pre-configured waiters available for resources for this service.- Specified by:
getWaiters
in interfaceSecurityAttribute
- Returns:
- The service waiters.
-
getPaginators
public SecurityAttributePaginators getPaginators()
Description copied from interface:SecurityAttribute
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 interfaceSecurityAttribute
- 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 userequiredParametersMap
- 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 backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-