Class RoverNodeClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.rover.RoverNodeClient
-
- All Implemented Interfaces:
RoverNode,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20201210") public class RoverNodeClient extends BaseSyncClient implements RoverNode
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classRoverNodeClient.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 RoverNode.
-
Constructor Summary
Constructors Constructor Description RoverNodeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.RoverNodeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.RoverNodeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.RoverNodeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.RoverNodeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.RoverNodeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.RoverNodeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.RoverNodeClient(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 RoverNodeClient.Builderbuilder()Create a builder for this client.ChangeRoverNodeCompartmentResponsechangeRoverNodeCompartment(ChangeRoverNodeCompartmentRequest request)Moves a rover node into a different compartment.voidclose()CreateRoverNodeResponsecreateRoverNode(CreateRoverNodeRequest request)Creates a new RoverNode.DeleteRoverNodeResponsedeleteRoverNode(DeleteRoverNodeRequest request)Deletes a RoverNode resource by identifiervoidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.StringgetClientCommonLibraryVersion()protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Get the endpoint of the client.Optional<String>getMinimumClientCommonLibraryVersionFromClient()Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.RoverNodePaginatorsgetPaginators()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.GetRoverNodeResponsegetRoverNode(GetRoverNodeRequest request)Gets a RoverNode by identifier.GetRoverNodeCertificateResponsegetRoverNodeCertificate(GetRoverNodeCertificateRequest request)Get the certificate for a rover nodeGetRoverNodeEncryptionKeyResponsegetRoverNodeEncryptionKey(GetRoverNodeEncryptionKeyRequest request)Get the data encryption key for a rover node.GetRoverNodeGetRptResponsegetRoverNodeGetRpt(GetRoverNodeGetRptRequest request)Get the resource principal token for a rover nodeRoverNodeWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.ListRoverNodesResponselistRoverNodes(ListRoverNodesRequest request)Returns a list of RoverNodes.voidrefreshClient()Rebuild the backingHttpClient.RoverNodeActionRetrieveCaBundleResponseroverNodeActionRetrieveCaBundle(RoverNodeActionRetrieveCaBundleRequest request)Retrieve Ca Bundle for a rover nodeRoverNodeActionSetKeyResponseroverNodeActionSetKey(RoverNodeActionSetKeyRequest request)Get the resource principal public key for a rover nodeRoverNodeGenerateCertificateResponseroverNodeGenerateCertificate(RoverNodeGenerateCertificateRequest request)Request to generate certificate for a roverNode.RoverNodeRenewCertificateResponseroverNodeRenewCertificate(RoverNodeRenewCertificateRequest request)Request to renew certificate for a roverNode.RoverNodeReplaceCertificateAuthorityResponseroverNodeReplaceCertificateAuthority(RoverNodeReplaceCertificateAuthorityRequest request)Request to replace certificate authority for a roverNode.RoverNodeRetrieveLeafCertificateResponseroverNodeRetrieveLeafCertificate(RoverNodeRetrieveLeafCertificateRequest request)Retrieve the leaf certificate info for a rover nodevoidsetEndpoint(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’).UpdateRoverNodeResponseupdateRoverNode(UpdateRoverNodeRequest request)Updates the RoverNodevoiduseRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)This method should be used to enable or disable the use of realm-specific endpoint template.-
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.rover.RoverNode
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
RoverNodeClient
@Deprecated public RoverNodeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeRoverNodeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
RoverNodeClient
@Deprecated public RoverNodeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeRoverNodeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
RoverNodeClient
@Deprecated public RoverNodeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeRoverNodeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
RoverNodeClient
@Deprecated public RoverNodeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeRoverNodeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
RoverNodeClient
@Deprecated public RoverNodeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeRoverNodeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
RoverNodeClient
@Deprecated public RoverNodeClient(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 (seeRoverNodeClient.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)
-
RoverNodeClient
@Deprecated public RoverNodeClient(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 (seeRoverNodeClient.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
-
RoverNodeClient
@Deprecated public RoverNodeClient(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 (seeRoverNodeClient.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-RoverNodeClient.Builder.executorService
-
-
Method Detail
-
builder
public static RoverNodeClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:RoverNodeSets 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.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:RoverNodeSets 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.
-
changeRoverNodeCompartment
public ChangeRoverNodeCompartmentResponse changeRoverNodeCompartment(ChangeRoverNodeCompartmentRequest request)
Description copied from interface:RoverNodeMoves a rover node into a different compartment.- Specified by:
changeRoverNodeCompartmentin interfaceRoverNode- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createRoverNode
public CreateRoverNodeResponse createRoverNode(CreateRoverNodeRequest request)
Description copied from interface:RoverNodeCreates a new RoverNode.- Specified by:
createRoverNodein interfaceRoverNode- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteRoverNode
public DeleteRoverNodeResponse deleteRoverNode(DeleteRoverNodeRequest request)
Description copied from interface:RoverNodeDeletes a RoverNode resource by identifier- Specified by:
deleteRoverNodein interfaceRoverNode- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getRoverNode
public GetRoverNodeResponse getRoverNode(GetRoverNodeRequest request)
Description copied from interface:RoverNodeGets a RoverNode by identifier.- Specified by:
getRoverNodein interfaceRoverNode- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getRoverNodeCertificate
public GetRoverNodeCertificateResponse getRoverNodeCertificate(GetRoverNodeCertificateRequest request)
Description copied from interface:RoverNodeGet the certificate for a rover node- Specified by:
getRoverNodeCertificatein interfaceRoverNode- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getRoverNodeEncryptionKey
public GetRoverNodeEncryptionKeyResponse getRoverNodeEncryptionKey(GetRoverNodeEncryptionKeyRequest request)
Description copied from interface:RoverNodeGet the data encryption key for a rover node.- Specified by:
getRoverNodeEncryptionKeyin interfaceRoverNode- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getRoverNodeGetRpt
public GetRoverNodeGetRptResponse getRoverNodeGetRpt(GetRoverNodeGetRptRequest request)
Description copied from interface:RoverNodeGet the resource principal token for a rover node- Specified by:
getRoverNodeGetRptin interfaceRoverNode- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listRoverNodes
public ListRoverNodesResponse listRoverNodes(ListRoverNodesRequest request)
Description copied from interface:RoverNodeReturns a list of RoverNodes.- Specified by:
listRoverNodesin interfaceRoverNode- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
roverNodeActionRetrieveCaBundle
public RoverNodeActionRetrieveCaBundleResponse roverNodeActionRetrieveCaBundle(RoverNodeActionRetrieveCaBundleRequest request)
Description copied from interface:RoverNodeRetrieve Ca Bundle for a rover node- Specified by:
roverNodeActionRetrieveCaBundlein interfaceRoverNode- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
roverNodeActionSetKey
public RoverNodeActionSetKeyResponse roverNodeActionSetKey(RoverNodeActionSetKeyRequest request)
Description copied from interface:RoverNodeGet the resource principal public key for a rover node- Specified by:
roverNodeActionSetKeyin interfaceRoverNode- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
roverNodeGenerateCertificate
public RoverNodeGenerateCertificateResponse roverNodeGenerateCertificate(RoverNodeGenerateCertificateRequest request)
Description copied from interface:RoverNodeRequest to generate certificate for a roverNode.- Specified by:
roverNodeGenerateCertificatein interfaceRoverNode- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
roverNodeRenewCertificate
public RoverNodeRenewCertificateResponse roverNodeRenewCertificate(RoverNodeRenewCertificateRequest request)
Description copied from interface:RoverNodeRequest to renew certificate for a roverNode.- Specified by:
roverNodeRenewCertificatein interfaceRoverNode- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
roverNodeReplaceCertificateAuthority
public RoverNodeReplaceCertificateAuthorityResponse roverNodeReplaceCertificateAuthority(RoverNodeReplaceCertificateAuthorityRequest request)
Description copied from interface:RoverNodeRequest to replace certificate authority for a roverNode.- Specified by:
roverNodeReplaceCertificateAuthorityin interfaceRoverNode- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
roverNodeRetrieveLeafCertificate
public RoverNodeRetrieveLeafCertificateResponse roverNodeRetrieveLeafCertificate(RoverNodeRetrieveLeafCertificateRequest request)
Description copied from interface:RoverNodeRetrieve the leaf certificate info for a rover node- Specified by:
roverNodeRetrieveLeafCertificatein interfaceRoverNode- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateRoverNode
public UpdateRoverNodeResponse updateRoverNode(UpdateRoverNodeRequest request)
Description copied from interface:RoverNodeUpdates the RoverNode- Specified by:
updateRoverNodein interfaceRoverNode- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public RoverNodeWaiters getWaiters()
Description copied from interface:RoverNodeGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceRoverNode- Returns:
- The service waiters.
-
getPaginators
public RoverNodePaginators getPaginators()
Description copied from interface:RoverNodeGets 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 interfaceRoverNode- 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()
-
-