com.oracle.bmc.computeinstanceagent

Class ComputeInstanceAgentClient

java.lang.Object

com.oracle.bmc.computeinstanceagent.ComputeInstanceAgentClient

All Implemented Interfaces:

ComputeInstanceAgent, AutoCloseable

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	ComputeInstanceAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Creates a new service instance using the given authentication provider and client configuration.
	ComputeInstanceAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Creates a new service instance using the given authentication provider and client configuration.
	ComputeInstanceAgentClient(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.
	ComputeInstanceAgentClient(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.
	ComputeInstanceAgentClient(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	ComputeInstanceAgentClient(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.
	ComputeInstanceAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Creates a new service instance using the given authentication provider.
	ComputeInstanceAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Creates a new service instance using the given authentication provider and client configuration.
	ComputeInstanceAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Creates a new service instance using the given authentication provider and client configuration.

Method Summary

Modifier and Type	Method and Description
static ComputeInstanceAgentClient.Builder	builder() Create a builder for this client.
CancelInstanceAgentCommandResponse	cancelInstanceAgentCommand(CancelInstanceAgentCommandRequest request) Cancels a command that is scheduled to run on a compute instance that is managed by Oracle Cloud Agent.
void	close()
CreateInstanceAgentCommandResponse	createInstanceAgentCommand(CreateInstanceAgentCommandRequest request) 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)
GetInstanceAgentCommandResponse	getInstanceAgentCommand(GetInstanceAgentCommandRequest request) Gets information about an Oracle Cloud Agent command.
GetInstanceAgentCommandExecutionResponse	getInstanceAgentCommandExecution(GetInstanceAgentCommandExecutionRequest request) Gets information about the status of specified instance agent commandId for the given instanceId.
ComputeInstanceAgentPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
ComputeInstanceAgentWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListInstanceAgentCommandExecutionsResponse	listInstanceAgentCommandExecutions(ListInstanceAgentCommandExecutionsRequest request) Lists the execution details for Oracle Cloud Agent commands that run on the specified compute instance.
ListInstanceAgentCommandsResponse	listInstanceAgentCommands(ListInstanceAgentCommandsRequest request) Lists the Oracle Cloud Agent commands issued in a compartment.
void	refreshClient() Rebuilds the client from scratch.
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’).

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 ComputeInstanceAgent.

Constructor Detail

ComputeInstanceAgentClient

public ComputeInstanceAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

ComputeInstanceAgentClient

public ComputeInstanceAgentClient(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.

ComputeInstanceAgentClient

public ComputeInstanceAgentClient(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.

ComputeInstanceAgentClient

public ComputeInstanceAgentClient(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.

ComputeInstanceAgentClient

public ComputeInstanceAgentClient(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.

ComputeInstanceAgentClient

public ComputeInstanceAgentClient(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)

ComputeInstanceAgentClient

public ComputeInstanceAgentClient(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)

ComputeInstanceAgentClient

public ComputeInstanceAgentClient(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

ComputeInstanceAgentClient

protected ComputeInstanceAgentClient(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 ComputeInstanceAgentClient.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 ComputeInstanceAgentClient.Builder builder()

Create a builder for this client.

Returns:

builder

refreshClient

public void refreshClient()

Description copied from interface: ComputeInstanceAgent

Rebuilds the client from scratch. Useful to refresh certificates.

Specified by:

refreshClient in interface ComputeInstanceAgent

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: ComputeInstanceAgent

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

Specified by:

setEndpoint in interface ComputeInstanceAgent

Parameters:

endpoint - The endpoint of the service.

getEndpoint

public String getEndpoint()

Description copied from interface: ComputeInstanceAgent

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

Specified by:

getEndpoint in interface ComputeInstanceAgent

setRegion

public void setRegion(Region region)

Description copied from interface: ComputeInstanceAgent

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 ComputeInstanceAgent

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ComputeInstanceAgent

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 ComputeInstanceAgent

Parameters:

regionId - The public region ID.

close

public void close()

Specified by:

close in interface AutoCloseable

cancelInstanceAgentCommand

public CancelInstanceAgentCommandResponse cancelInstanceAgentCommand(CancelInstanceAgentCommandRequest request)

Description copied from interface: ComputeInstanceAgent

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 ComputeInstanceAgent

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createInstanceAgentCommand

public CreateInstanceAgentCommandResponse createInstanceAgentCommand(CreateInstanceAgentCommandRequest request)

Description copied from interface: ComputeInstanceAgent

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 ComputeInstanceAgent

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getInstanceAgentCommand

public GetInstanceAgentCommandResponse getInstanceAgentCommand(GetInstanceAgentCommandRequest request)

Description copied from interface: ComputeInstanceAgent

Gets information about an Oracle Cloud Agent command.

Specified by:

getInstanceAgentCommand in interface ComputeInstanceAgent

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getInstanceAgentCommandExecution

public GetInstanceAgentCommandExecutionResponse getInstanceAgentCommandExecution(GetInstanceAgentCommandExecutionRequest request)

Description copied from interface: ComputeInstanceAgent

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

Specified by:

getInstanceAgentCommandExecution in interface ComputeInstanceAgent

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listInstanceAgentCommandExecutions

public ListInstanceAgentCommandExecutionsResponse listInstanceAgentCommandExecutions(ListInstanceAgentCommandExecutionsRequest request)

Description copied from interface: ComputeInstanceAgent

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

Specified by:

listInstanceAgentCommandExecutions in interface ComputeInstanceAgent

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listInstanceAgentCommands

public ListInstanceAgentCommandsResponse listInstanceAgentCommands(ListInstanceAgentCommandsRequest request)

Description copied from interface: ComputeInstanceAgent

Lists the Oracle Cloud Agent commands issued in a compartment.

Specified by:

listInstanceAgentCommands in interface ComputeInstanceAgent

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public ComputeInstanceAgentWaiters getWaiters()

Description copied from interface: ComputeInstanceAgent

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface ComputeInstanceAgent

Returns:

The service waiters.

getPaginators

public ComputeInstanceAgentPaginators getPaginators()

Description copied from interface: ComputeInstanceAgent

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 ComputeInstanceAgent

Returns:

The service paginators.