com.oracle.bmc.computeinstanceagent

Class ComputeInstanceAgentClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.computeinstanceagent.ComputeInstanceAgentClient

All Implemented Interfaces:

ComputeInstanceAgent, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180530")
public class ComputeInstanceAgentClient
extends BaseSyncClient
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

Constructor and Description
ComputeInstanceAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
ComputeInstanceAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
ComputeInstanceAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
ComputeInstanceAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
ComputeInstanceAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
ComputeInstanceAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
ComputeInstanceAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
ComputeInstanceAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

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.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
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	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
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’).
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
void	useRealmSpecificEndpointTemplate(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 com.oracle.bmc.computeinstanceagent.ComputeInstanceAgent

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ComputeInstanceAgent.

Constructor Detail

ComputeInstanceAgentClient

@Deprecated
public ComputeInstanceAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ComputeInstanceAgentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

ComputeInstanceAgentClient

@Deprecated
public ComputeInstanceAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ComputeInstanceAgentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

ComputeInstanceAgentClient

@Deprecated
public ComputeInstanceAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration,
                                              ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ComputeInstanceAgentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

ComputeInstanceAgentClient

@Deprecated
public ComputeInstanceAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration,
                                              ClientConfigurator clientConfigurator,
                                              RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ComputeInstanceAgentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ComputeInstanceAgentClient

@Deprecated
public ComputeInstanceAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration,
                                              ClientConfigurator clientConfigurator,
                                              RequestSignerFactory defaultRequestSignerFactory,
                                              List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ComputeInstanceAgentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ComputeInstanceAgentClient

@Deprecated
public ComputeInstanceAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration,
                                              ClientConfigurator clientConfigurator,
                                              RequestSignerFactory defaultRequestSignerFactory,
                                              List<ClientConfigurator> additionalClientConfigurators,
                                              String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ComputeInstanceAgentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

ComputeInstanceAgentClient

@Deprecated
public ComputeInstanceAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration,
                                              ClientConfigurator clientConfigurator,
                                              RequestSignerFactory defaultRequestSignerFactory,
                                              Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                              List<ClientConfigurator> additionalClientConfigurators,
                                              String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ComputeInstanceAgentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

ComputeInstanceAgentClient

@Deprecated
public ComputeInstanceAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration,
                                              ClientConfigurator clientConfigurator,
                                              RequestSignerFactory defaultRequestSignerFactory,
                                              Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                              List<ClientConfigurator> additionalClientConfigurators,
                                              String endpoint,
                                              ExecutorService executorService)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ComputeInstanceAgentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - ComputeInstanceAgentClient.Builder.executorService

Method Detail

builder

public static ComputeInstanceAgentClient.Builder builder()

Create a builder for this client.

Returns:

builder

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.

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.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable