@Generated(value="OracleSDKGenerator", comments="API Version: 20180530") public class ComputeInstanceAgentClient extends Object implements ComputeInstanceAgent
Modifier and Type | Class and Description |
---|---|
static class |
ComputeInstanceAgentClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for ComputeInstanceAgent.
|
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.
|
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’).
|
public static final Service SERVICE
Service instance for ComputeInstanceAgent.
public ComputeInstanceAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public ComputeInstanceAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.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.
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.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.
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.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.
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.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.
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
)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.
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 signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)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.
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 signeradditionalClientConfigurators
- 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 ThreadPoolExecutorprotected 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.
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 signeradditionalClientConfigurators
- 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 ThreadPoolExecutorrestClientFactoryBuilder
- the builder for the RestClientFactory
public static ComputeInstanceAgentClient.Builder builder()
Create a builder for this client.
public void refreshClient()
ComputeInstanceAgent
Rebuilds the client from scratch. Useful to refresh certificates.
refreshClient
in interface ComputeInstanceAgent
public void setEndpoint(String endpoint)
ComputeInstanceAgent
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface ComputeInstanceAgent
endpoint
- The endpoint of the service.public String getEndpoint()
ComputeInstanceAgent
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface ComputeInstanceAgent
public void setRegion(Region region)
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.
setRegion
in interface ComputeInstanceAgent
region
- The region of the service.public void setRegion(String regionId)
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
.
setRegion
in interface ComputeInstanceAgent
regionId
- The public region ID.public void close()
close
in interface AutoCloseable
public CancelInstanceAgentCommandResponse cancelInstanceAgentCommand(CancelInstanceAgentCommandRequest request)
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.
cancelInstanceAgentCommand
in interface ComputeInstanceAgent
request
- The request object containing the details to sendpublic CreateInstanceAgentCommandResponse createInstanceAgentCommand(CreateInstanceAgentCommandRequest request)
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.
createInstanceAgentCommand
in interface ComputeInstanceAgent
request
- The request object containing the details to sendpublic GetInstanceAgentCommandResponse getInstanceAgentCommand(GetInstanceAgentCommandRequest request)
ComputeInstanceAgent
Gets information about an Oracle Cloud Agent command.
getInstanceAgentCommand
in interface ComputeInstanceAgent
request
- The request object containing the details to sendpublic GetInstanceAgentCommandExecutionResponse getInstanceAgentCommandExecution(GetInstanceAgentCommandExecutionRequest request)
ComputeInstanceAgent
Gets information about the status of specified instance agent commandId for the given instanceId.
getInstanceAgentCommandExecution
in interface ComputeInstanceAgent
request
- The request object containing the details to sendpublic ListInstanceAgentCommandExecutionsResponse listInstanceAgentCommandExecutions(ListInstanceAgentCommandExecutionsRequest request)
ComputeInstanceAgent
Lists the execution details for Oracle Cloud Agent commands that run on the specified compute instance.
listInstanceAgentCommandExecutions
in interface ComputeInstanceAgent
request
- The request object containing the details to sendpublic ListInstanceAgentCommandsResponse listInstanceAgentCommands(ListInstanceAgentCommandsRequest request)
ComputeInstanceAgent
Lists the Oracle Cloud Agent commands issued in a compartment.
listInstanceAgentCommands
in interface ComputeInstanceAgent
request
- The request object containing the details to sendpublic ComputeInstanceAgentWaiters getWaiters()
ComputeInstanceAgent
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface ComputeInstanceAgent
public ComputeInstanceAgentPaginators getPaginators()
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.
getPaginators
in interface ComputeInstanceAgent
Copyright © 2016–2022. All rights reserved.