com.oracle.bmc.computeinstanceagent

Class ComputeInstanceAgentAsyncClient

java.lang.Object

com.oracle.bmc.computeinstanceagent.ComputeInstanceAgentAsyncClient

All Implemented Interfaces:

ComputeInstanceAgentAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180530")
public class ComputeInstanceAgentAsyncClient
extends Object
implements ComputeInstanceAgentAsync

Async client implementation for ComputeInstanceAgent service.
There are two ways to use async client:

1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
   
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
   Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
   Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static com.oracle.bmc.Service	SERVICE Service instance for ComputeInstanceAgent.

Constructor Summary

Constructors

Constructor and Description
ComputeInstanceAgentAsyncClient(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider, com.oracle.bmc.ClientConfiguration configuration, com.oracle.bmc.http.ClientConfigurator clientConfigurator, com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory) Creates a new service instance using the given authentication provider and client configuration.
ComputeInstanceAgentAsyncClient(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider, com.oracle.bmc.ClientConfiguration configuration, com.oracle.bmc.http.ClientConfigurator clientConfigurator, com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory, List<com.oracle.bmc.http.ClientConfigurator> additionalClientConfigurators) Creates a new service instance using the given authentication provider and client configuration.
ComputeInstanceAgentAsyncClient(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider, com.oracle.bmc.ClientConfiguration configuration, com.oracle.bmc.http.ClientConfigurator clientConfigurator, com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory, List<com.oracle.bmc.http.ClientConfigurator> additionalClientConfigurators, String endpoint) Creates a new service instance using the given authentication provider and client configuration.
ComputeInstanceAgentAsyncClient(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider, com.oracle.bmc.ClientConfiguration configuration, com.oracle.bmc.http.ClientConfigurator clientConfigurator, com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory, Map<com.oracle.bmc.http.signing.SigningStrategy,com.oracle.bmc.http.signing.RequestSignerFactory> signingStrategyRequestSignerFactories, List<com.oracle.bmc.http.ClientConfigurator> additionalClientConfigurators, String endpoint) Creates a new service instance using the given authentication provider and client configuration.
ComputeInstanceAgentAsyncClient(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider, com.oracle.bmc.ClientConfiguration configuration, com.oracle.bmc.http.ClientConfigurator clientConfigurator, com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory, Map<com.oracle.bmc.http.signing.SigningStrategy,com.oracle.bmc.http.signing.RequestSignerFactory> signingStrategyRequestSignerFactories, List<com.oracle.bmc.http.ClientConfigurator> additionalClientConfigurators, String endpoint, com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder) Creates a new service instance using the given authentication provider and client configuration.
ComputeInstanceAgentAsyncClient(com.oracle.bmc.auth.BasicAuthenticationDetailsProvider authenticationDetailsProvider) Creates a new service instance using the given authentication provider.
ComputeInstanceAgentAsyncClient(com.oracle.bmc.auth.BasicAuthenticationDetailsProvider authenticationDetailsProvider, com.oracle.bmc.ClientConfiguration configuration) Creates a new service instance using the given authentication provider and client configuration.
ComputeInstanceAgentAsyncClient(com.oracle.bmc.auth.BasicAuthenticationDetailsProvider authenticationDetailsProvider, com.oracle.bmc.ClientConfiguration configuration, com.oracle.bmc.http.ClientConfigurator clientConfigurator) Creates a new service instance using the given authentication provider and client configuration.

Method Summary

Modifier and Type	Method and Description
static ComputeInstanceAgentAsyncClient.Builder	builder() Create a builder for this client.
Future<CancelInstanceAgentCommandResponse>	cancelInstanceAgentCommand(CancelInstanceAgentCommandRequest request, com.oracle.bmc.responses.AsyncHandler<CancelInstanceAgentCommandRequest,CancelInstanceAgentCommandResponse> handler) Cancels a command that is scheduled to run on a compute instance that is managed by Oracle Cloud Agent.
void	close()
Future<CreateInstanceAgentCommandResponse>	createInstanceAgentCommand(CreateInstanceAgentCommandRequest request, com.oracle.bmc.responses.AsyncHandler<CreateInstanceAgentCommandRequest,CreateInstanceAgentCommandResponse> handler) Creates a command or script to run on a compute instance that is managed by Oracle Cloud Agent.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetInstanceAgentCommandResponse>	getInstanceAgentCommand(GetInstanceAgentCommandRequest request, com.oracle.bmc.responses.AsyncHandler<GetInstanceAgentCommandRequest,GetInstanceAgentCommandResponse> handler) Gets information about an Oracle Cloud Agent command.
Future<GetInstanceAgentCommandExecutionResponse>	getInstanceAgentCommandExecution(GetInstanceAgentCommandExecutionRequest request, com.oracle.bmc.responses.AsyncHandler<GetInstanceAgentCommandExecutionRequest,GetInstanceAgentCommandExecutionResponse> handler) Gets information about the status of specified instance agent commandId for the given instanceId.
Future<ListInstanceAgentCommandExecutionsResponse>	listInstanceAgentCommandExecutions(ListInstanceAgentCommandExecutionsRequest request, com.oracle.bmc.responses.AsyncHandler<ListInstanceAgentCommandExecutionsRequest,ListInstanceAgentCommandExecutionsResponse> handler) Lists the execution details for Oracle Cloud Agent commands that run on the specified compute instance.
Future<ListInstanceAgentCommandsResponse>	listInstanceAgentCommands(ListInstanceAgentCommandsRequest request, com.oracle.bmc.responses.AsyncHandler<ListInstanceAgentCommandsRequest,ListInstanceAgentCommandsResponse> handler) Lists the Oracle Cloud Agent commands issued in a compartment.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(com.oracle.bmc.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’).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SERVICE

public static final com.oracle.bmc.Service SERVICE

Service instance for ComputeInstanceAgent.

Constructor Detail

ComputeInstanceAgentAsyncClient

public ComputeInstanceAgentAsyncClient(com.oracle.bmc.auth.BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

ComputeInstanceAgentAsyncClient

public ComputeInstanceAgentAsyncClient(com.oracle.bmc.auth.BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                       com.oracle.bmc.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.

ComputeInstanceAgentAsyncClient

public ComputeInstanceAgentAsyncClient(com.oracle.bmc.auth.BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                       com.oracle.bmc.ClientConfiguration configuration,
                                       com.oracle.bmc.http.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.

ComputeInstanceAgentAsyncClient

public ComputeInstanceAgentAsyncClient(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                       com.oracle.bmc.ClientConfiguration configuration,
                                       com.oracle.bmc.http.ClientConfigurator clientConfigurator,
                                       com.oracle.bmc.http.signing.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.

ComputeInstanceAgentAsyncClient

public ComputeInstanceAgentAsyncClient(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                       com.oracle.bmc.ClientConfiguration configuration,
                                       com.oracle.bmc.http.ClientConfigurator clientConfigurator,
                                       com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory,
                                       List<com.oracle.bmc.http.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.

ComputeInstanceAgentAsyncClient

public ComputeInstanceAgentAsyncClient(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                       com.oracle.bmc.ClientConfiguration configuration,
                                       com.oracle.bmc.http.ClientConfigurator clientConfigurator,
                                       com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory,
                                       List<com.oracle.bmc.http.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)

ComputeInstanceAgentAsyncClient

public ComputeInstanceAgentAsyncClient(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                       com.oracle.bmc.ClientConfiguration configuration,
                                       com.oracle.bmc.http.ClientConfigurator clientConfigurator,
                                       com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory,
                                       Map<com.oracle.bmc.http.signing.SigningStrategy,com.oracle.bmc.http.signing.RequestSignerFactory> signingStrategyRequestSignerFactories,
                                       List<com.oracle.bmc.http.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)

ComputeInstanceAgentAsyncClient

public ComputeInstanceAgentAsyncClient(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                       com.oracle.bmc.ClientConfiguration configuration,
                                       com.oracle.bmc.http.ClientConfigurator clientConfigurator,
                                       com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory,
                                       Map<com.oracle.bmc.http.signing.SigningStrategy,com.oracle.bmc.http.signing.RequestSignerFactory> signingStrategyRequestSignerFactories,
                                       List<com.oracle.bmc.http.ClientConfigurator> additionalClientConfigurators,
                                       String endpoint,
                                       com.oracle.bmc.http.internal.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.

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)

restClientFactoryBuilder - the builder for the RestClientFactory

Method Detail

builder

public static ComputeInstanceAgentAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: ComputeInstanceAgentAsync

Sets the endpoint to call (ex, https://www.example.com).

Specified by:

setEndpoint in interface ComputeInstanceAgentAsync

Parameters:

endpoint - The endpoint of the serice.

getEndpoint

public String getEndpoint()

Description copied from interface: ComputeInstanceAgentAsync

Gets the set endpoint for REST call (ex, https://www.example.com)

Specified by:

getEndpoint in interface ComputeInstanceAgentAsync

setRegion

public void setRegion(com.oracle.bmc.Region region)

Description copied from interface: ComputeInstanceAgentAsync

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 ComputeInstanceAgentAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ComputeInstanceAgentAsync

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 ComputeInstanceAgentAsync

Parameters:

regionId - The public region ID.

close

public void close()

Specified by:

close in interface AutoCloseable

cancelInstanceAgentCommand

public Future<CancelInstanceAgentCommandResponse> cancelInstanceAgentCommand(CancelInstanceAgentCommandRequest request,
                                                                             com.oracle.bmc.responses.AsyncHandler<CancelInstanceAgentCommandRequest,CancelInstanceAgentCommandResponse> handler)

Description copied from interface: ComputeInstanceAgentAsync

Cancels a command that is scheduled to run on a compute instance that is managed by Oracle Cloud Agent.

Canceling a command is a best-effort attempt. If the command has already completed, it will not be canceled.

Specified by:

cancelInstanceAgentCommand in interface ComputeInstanceAgentAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createInstanceAgentCommand

public Future<CreateInstanceAgentCommandResponse> createInstanceAgentCommand(CreateInstanceAgentCommandRequest request,
                                                                             com.oracle.bmc.responses.AsyncHandler<CreateInstanceAgentCommandRequest,CreateInstanceAgentCommandResponse> handler)

Description copied from interface: ComputeInstanceAgentAsync

Creates a command or script to run on a compute instance that is managed by Oracle Cloud Agent.

On Linux instances, the script runs in a bash shell. On Windows instances, the script runs in a batch shell.

Commands that require administrator privileges will run only if Oracle Cloud Agent is running with administrator privileges.

Specified by:

createInstanceAgentCommand in interface ComputeInstanceAgentAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getInstanceAgentCommand

public Future<GetInstanceAgentCommandResponse> getInstanceAgentCommand(GetInstanceAgentCommandRequest request,
                                                                       com.oracle.bmc.responses.AsyncHandler<GetInstanceAgentCommandRequest,GetInstanceAgentCommandResponse> handler)

Description copied from interface: ComputeInstanceAgentAsync

Gets information about an Oracle Cloud Agent command.

Specified by:

getInstanceAgentCommand in interface ComputeInstanceAgentAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getInstanceAgentCommandExecution

public Future<GetInstanceAgentCommandExecutionResponse> getInstanceAgentCommandExecution(GetInstanceAgentCommandExecutionRequest request,
                                                                                         com.oracle.bmc.responses.AsyncHandler<GetInstanceAgentCommandExecutionRequest,GetInstanceAgentCommandExecutionResponse> handler)

Description copied from interface: ComputeInstanceAgentAsync

Gets information about the status of specified instance agent commandId for the given instanceId.

Specified by:

getInstanceAgentCommandExecution in interface ComputeInstanceAgentAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listInstanceAgentCommandExecutions

public Future<ListInstanceAgentCommandExecutionsResponse> listInstanceAgentCommandExecutions(ListInstanceAgentCommandExecutionsRequest request,
                                                                                             com.oracle.bmc.responses.AsyncHandler<ListInstanceAgentCommandExecutionsRequest,ListInstanceAgentCommandExecutionsResponse> handler)

Description copied from interface: ComputeInstanceAgentAsync

Lists the execution details for Oracle Cloud Agent commands that run on the specified compute instance.

Specified by:

listInstanceAgentCommandExecutions in interface ComputeInstanceAgentAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listInstanceAgentCommands

public Future<ListInstanceAgentCommandsResponse> listInstanceAgentCommands(ListInstanceAgentCommandsRequest request,
                                                                           com.oracle.bmc.responses.AsyncHandler<ListInstanceAgentCommandsRequest,ListInstanceAgentCommandsResponse> handler)

Description copied from interface: ComputeInstanceAgentAsync

Lists the Oracle Cloud Agent commands issued in a compartment.

Specified by:

listInstanceAgentCommands in interface ComputeInstanceAgentAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.