RoverNodeClient (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.rover.RoverNodeClient

All Implemented Interfaces:: RoverNode, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20201210")
public class RoverNodeClient
extends Object
implements RoverNode

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RoverNodeClient.Builder
Builder class for this client.

Nested Classes
Modifier and Type	Class and Description
`static class`	`RoverNodeClient.Builder` Builder class for this client.

Field Summary

Fields
Modifier and Type Field and Description

static Service SERVICE
Service instance for RoverNode.

Fields
Modifier and Type	Field and Description
`static Service`	`SERVICE` Service instance for RoverNode.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`RoverNodeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)` Creates a new service instance using the given authentication provider and client configuration.
	`RoverNodeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)` Creates a new service instance using the given authentication provider and client configuration.
	`RoverNodeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
	`RoverNodeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
	`RoverNodeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)` Creates a new service instance using the given authentication provider and client configuration.
`protected`	`RoverNodeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, RestClientFactoryBuilder restClientFactoryBuilder)` Creates a new service instance using the given authentication provider and client configuration.
	`RoverNodeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)` Creates a new service instance using the given authentication provider.
	`RoverNodeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)` Creates a new service instance using the given authentication provider and client configuration.
	`RoverNodeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)` Creates a new service instance using the given authentication provider and client configuration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RoverNodeClient.Builder`	`builder()` Create a builder for this client.
`ChangeRoverNodeCompartmentResponse`	`changeRoverNodeCompartment(ChangeRoverNodeCompartmentRequest request)` Moves a rover node into a different compartment.
`void`	`close()`
`CreateRoverNodeResponse`	`createRoverNode(CreateRoverNodeRequest request)` Creates a new RoverNode.
`DeleteRoverNodeResponse`	`deleteRoverNode(DeleteRoverNodeRequest request)` Deletes a RoverNode resource by identifier
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`RoverNodePaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`GetRoverNodeResponse`	`getRoverNode(GetRoverNodeRequest request)` Gets a RoverNode by identifier.
`GetRoverNodeCertificateResponse`	`getRoverNodeCertificate(GetRoverNodeCertificateRequest request)` Get the certificate for a rover node
`GetRoverNodeEncryptionKeyResponse`	`getRoverNodeEncryptionKey(GetRoverNodeEncryptionKeyRequest request)` Get the data encryption key for a rover node.
`GetRoverNodeGetRptResponse`	`getRoverNodeGetRpt(GetRoverNodeGetRptRequest request)` Get the resource principal token for a rover node
`RoverNodeWaiters`	`getWaiters()` Gets the pre-configured waiters available for resources for this service.
`ListRoverNodesResponse`	`listRoverNodes(ListRoverNodesRequest request)` Returns a list of RoverNodes.
`void`	`refreshClient()` Rebuilds the client from scratch.
`RoverNodeActionSetKeyResponse`	`roverNodeActionSetKey(RoverNodeActionSetKeyRequest request)` Get the resource principal public key for a rover node
`void`	`setEndpoint(String endpoint)` Sets the endpoint to call (ex, https://www.example.com).
`void`	`setRegion(Region region)` Sets the region to call (ex, Region.US_PHOENIX_1).
`void`	`setRegion(String regionId)` Sets the region to call (ex, ‘us-phoenix-1’).
`UpdateRoverNodeResponse`	`updateRoverNode(UpdateRoverNodeRequest request)` Updates the RoverNode

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for RoverNode.
- Constructor Detail
  - RoverNodeClient
```
public RoverNodeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Creates a new service instance using the given authentication provider.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
  - RoverNodeClient
```
public RoverNodeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration)
```
    Creates a new service instance using the given authentication provider and client configuration.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
  - RoverNodeClient
```
public RoverNodeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
  - RoverNodeClient
```
public RoverNodeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator,
                       RequestSignerFactory defaultRequestSignerFactory)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
  - RoverNodeClient
```
public RoverNodeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator,
                       RequestSignerFactory defaultRequestSignerFactory,
                       List<ClientConfigurator> additionalClientConfigurators)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
  - RoverNodeClient
```
public RoverNodeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator,
                       RequestSignerFactory defaultRequestSignerFactory,
                       List<ClientConfigurator> additionalClientConfigurators,
                       String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - RoverNodeClient
```
public RoverNodeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator,
                       RequestSignerFactory defaultRequestSignerFactory,
                       Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                       List<ClientConfigurator> additionalClientConfigurators,
                       String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - RoverNodeClient
```
public RoverNodeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator,
                       RequestSignerFactory defaultRequestSignerFactory,
                       Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                       List<ClientConfigurator> additionalClientConfigurators,
                       String endpoint,
                       ExecutorService executorService)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor
  - RoverNodeClient
```
protected RoverNodeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory,
                          Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                          List<ClientConfigurator> additionalClientConfigurators,
                          String endpoint,
                          ExecutorService executorService,
                          RestClientFactoryBuilder restClientFactoryBuilder)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed. Use the RoverNodeClient.Builder to get access to all these parameters.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor
    
    restClientFactoryBuilder - the builder for the RestClientFactory
- Method Detail
  - builder
```
public static RoverNodeClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - refreshClient
```
public void refreshClient()
```
    Description copied from interface: RoverNode
    
    Rebuilds the client from scratch. Useful to refresh certificates.
    
    Specified by:
    
    refreshClient in interface RoverNode
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: RoverNode
    
    Sets the endpoint to call (ex, https://www.example.com).
    
    Specified by:
    
    setEndpoint in interface RoverNode
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
public String getEndpoint()
```
    Description copied from interface: RoverNode
    
    Gets the set endpoint for REST call (ex, https://www.example.com)
    
    Specified by:
    
    getEndpoint in interface RoverNode
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: RoverNode
    
    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 RoverNode
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: RoverNode
    
    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 RoverNode
    
    Parameters:
    
    regionId - The public region ID.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - changeRoverNodeCompartment
```
public ChangeRoverNodeCompartmentResponse changeRoverNodeCompartment(ChangeRoverNodeCompartmentRequest request)
```
    Description copied from interface: RoverNode
    
    Moves a rover node into a different compartment.
    
    Specified by:
    
    changeRoverNodeCompartment in interface RoverNode
    
    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: RoverNode
    
    Creates a new RoverNode.
    
    Specified by:
    
    createRoverNode in interface RoverNode
    
    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: RoverNode
    
    Deletes a RoverNode resource by identifier
    
    Specified by:
    
    deleteRoverNode in interface RoverNode
    
    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: RoverNode
    
    Gets a RoverNode by identifier.
    
    Specified by:
    
    getRoverNode in interface RoverNode
    
    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: RoverNode
    
    Get the certificate for a rover node
    
    Specified by:
    
    getRoverNodeCertificate in interface RoverNode
    
    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: RoverNode
    
    Get the data encryption key for a rover node.
    
    Specified by:
    
    getRoverNodeEncryptionKey in interface RoverNode
    
    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: RoverNode
    
    Get the resource principal token for a rover node
    
    Specified by:
    
    getRoverNodeGetRpt in interface RoverNode
    
    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: RoverNode
    
    Returns a list of RoverNodes.
    
    Specified by:
    
    listRoverNodes in interface RoverNode
    
    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: RoverNode
    
    Get the resource principal public key for a rover node
    
    Specified by:
    
    roverNodeActionSetKey in interface RoverNode
    
    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: RoverNode
    
    Updates the RoverNode
    
    Specified by:
    
    updateRoverNode in interface RoverNode
    
    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: RoverNode
    
    Gets the pre-configured waiters available for resources for this service.
    
    Specified by:
    
    getWaiters in interface RoverNode
    
    Returns:
    
    The service waiters.
  - getPaginators
```
public RoverNodePaginators getPaginators()
```
    Description copied from interface: RoverNode
    
    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 RoverNode
    
    Returns:
    
    The service paginators.

Class RoverNodeClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE

Constructor Detail

RoverNodeClient

RoverNodeClient

RoverNodeClient

RoverNodeClient

RoverNodeClient

RoverNodeClient

RoverNodeClient

RoverNodeClient

RoverNodeClient

Method Detail

builder

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

close

changeRoverNodeCompartment

createRoverNode

deleteRoverNode

getRoverNode

getRoverNodeCertificate

getRoverNodeEncryptionKey

getRoverNodeGetRpt

listRoverNodes

roverNodeActionSetKey

updateRoverNode

getWaiters

getPaginators