@Generated(value="OracleSDKGenerator", comments="API Version: 20220509") public class OcbAgentSvcClient extends BaseSyncClient implements OcbAgentSvc
Modifier and Type | Class and Description |
---|---|
static class |
OcbAgentSvcClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
String |
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.
|
Optional<String> |
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.
|
static Service |
SERVICE
Service instance for OcbAgentSvc.
|
Constructor and Description |
---|
OcbAgentSvcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
OcbAgentSvcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
OcbAgentSvcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
OcbAgentSvcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
OcbAgentSvcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Deprecated.
Use the
builder instead. |
OcbAgentSvcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
OcbAgentSvcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
OcbAgentSvcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
Modifier and Type | Method and Description |
---|---|
AddAgentDependencyResponse |
addAgentDependency(AddAgentDependencyRequest request)
Add a dependency to the environment.
|
static OcbAgentSvcClient.Builder |
builder()
Create a builder for this client.
|
ChangeAgentCompartmentResponse |
changeAgentCompartment(ChangeAgentCompartmentRequest request)
Moves an Agent resource from one compartment identifier to another.
|
ChangeAgentDependencyCompartmentResponse |
changeAgentDependencyCompartment(ChangeAgentDependencyCompartmentRequest request)
Moves a AgentDependency resource from one compartment identifier to another.
|
ChangeEnvironmentCompartmentResponse |
changeEnvironmentCompartment(ChangeEnvironmentCompartmentRequest request)
Moves a source environment resource from one compartment identifier to another.
|
void |
close() |
CreateAgentResponse |
createAgent(CreateAgentRequest request)
Creates an Agent.
|
CreateAgentDependencyResponse |
createAgentDependency(CreateAgentDependencyRequest request)
Creates an AgentDependency.
|
CreateEnvironmentResponse |
createEnvironment(CreateEnvironmentRequest request)
Creates a source environment.
|
DeleteAgentResponse |
deleteAgent(DeleteAgentRequest request)
Deletes an Agent resource identified by an identifier.
|
DeleteAgentDependencyResponse |
deleteAgentDependency(DeleteAgentDependencyRequest request)
Deletes the AgentDependency resource based on an identifier.
|
DeleteEnvironmentResponse |
deleteEnvironment(DeleteEnvironmentRequest request)
Deletes a the source environment resource identified by an identifier.
|
GetAgentResponse |
getAgent(GetAgentRequest request)
Gets an Agent by identifier.
|
GetAgentDependencyResponse |
getAgentDependency(GetAgentDependencyRequest request)
Gets an AgentDependency by identifier.
|
String |
getClientCommonLibraryVersion() |
protected ClientConfigurator |
getDefaultConfigurator() |
String |
getEndpoint() |
GetEnvironmentResponse |
getEnvironment(GetEnvironmentRequest request)
Gets a source environment by identifier.
|
Optional<String> |
getMinimumClientCommonLibraryVersionFromClient() |
OcbAgentSvcPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data.
|
GetPluginResponse |
getPlugin(GetPluginRequest request)
Gets a plugin by identifier.
|
OcbAgentSvcWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
ListAgentDependenciesResponse |
listAgentDependencies(ListAgentDependenciesRequest request)
Returns a list of AgentDependencies such as AgentDependencyCollection.
|
ListAgentsResponse |
listAgents(ListAgentsRequest request)
Returns a list of Agents.
|
ListApplianceImagesResponse |
listApplianceImages(ListApplianceImagesRequest request)
Returns a list of Appliance Images.
|
ListEnvironmentsResponse |
listEnvironments(ListEnvironmentsRequest request)
Returns a list of source environments.
|
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 . |
RemoveAgentDependencyResponse |
removeAgentDependency(RemoveAgentDependencyRequest request)
Adds a dependency to the source environment.
|
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’).
|
UpdateAgentResponse |
updateAgent(UpdateAgentRequest request)
Updates the Agent.
|
UpdateAgentDependencyResponse |
updateAgentDependency(UpdateAgentDependencyRequest request)
Updates the AgentDependency.
|
void |
updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.
|
UpdateEnvironmentResponse |
updateEnvironment(UpdateEnvironmentRequest request)
Updates the source environment.
|
UpdatePluginResponse |
updatePlugin(UpdatePluginRequest request)
Updates the plugin.
|
void |
useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.
|
clientCall
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for OcbAgentSvc.
public final String clientCommonLibraryVersion
@Deprecated public OcbAgentSvcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see OcbAgentSvcClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public OcbAgentSvcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see OcbAgentSvcClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public OcbAgentSvcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see OcbAgentSvcClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public OcbAgentSvcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see OcbAgentSvcClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
@Deprecated public OcbAgentSvcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see OcbAgentSvcClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
@Deprecated public OcbAgentSvcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see OcbAgentSvcClient.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)
@Deprecated public OcbAgentSvcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see OcbAgentSvcClient.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
@Deprecated public OcbAgentSvcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see OcbAgentSvcClient.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
- OcbAgentSvcClient.Builder.executorService
public static OcbAgentSvcClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
OcbAgentSvc
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 OcbAgentSvc
region
- The region of the service.public void setRegion(String regionId)
OcbAgentSvc
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 OcbAgentSvc
regionId
- The public region ID.public AddAgentDependencyResponse addAgentDependency(AddAgentDependencyRequest request)
OcbAgentSvc
Add a dependency to the environment. When provided, If-Match is checked against ETag values of the resource.
addAgentDependency
in interface OcbAgentSvc
request
- The request object containing the details to sendpublic ChangeAgentCompartmentResponse changeAgentCompartment(ChangeAgentCompartmentRequest request)
OcbAgentSvc
Moves an Agent resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
changeAgentCompartment
in interface OcbAgentSvc
request
- The request object containing the details to sendpublic ChangeAgentDependencyCompartmentResponse changeAgentDependencyCompartment(ChangeAgentDependencyCompartmentRequest request)
OcbAgentSvc
Moves a AgentDependency resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
changeAgentDependencyCompartment
in interface OcbAgentSvc
request
- The request object containing the details to sendpublic ChangeEnvironmentCompartmentResponse changeEnvironmentCompartment(ChangeEnvironmentCompartmentRequest request)
OcbAgentSvc
Moves a source environment resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
changeEnvironmentCompartment
in interface OcbAgentSvc
request
- The request object containing the details to sendpublic CreateAgentResponse createAgent(CreateAgentRequest request)
OcbAgentSvc
Creates an Agent.
createAgent
in interface OcbAgentSvc
request
- The request object containing the details to sendpublic CreateAgentDependencyResponse createAgentDependency(CreateAgentDependencyRequest request)
OcbAgentSvc
Creates an AgentDependency.
createAgentDependency
in interface OcbAgentSvc
request
- The request object containing the details to sendpublic CreateEnvironmentResponse createEnvironment(CreateEnvironmentRequest request)
OcbAgentSvc
Creates a source environment.
createEnvironment
in interface OcbAgentSvc
request
- The request object containing the details to sendpublic DeleteAgentResponse deleteAgent(DeleteAgentRequest request)
OcbAgentSvc
Deletes an Agent resource identified by an identifier.
deleteAgent
in interface OcbAgentSvc
request
- The request object containing the details to sendpublic DeleteAgentDependencyResponse deleteAgentDependency(DeleteAgentDependencyRequest request)
OcbAgentSvc
Deletes the AgentDependency resource based on an identifier.
deleteAgentDependency
in interface OcbAgentSvc
request
- The request object containing the details to sendpublic DeleteEnvironmentResponse deleteEnvironment(DeleteEnvironmentRequest request)
OcbAgentSvc
Deletes a the source environment resource identified by an identifier.
deleteEnvironment
in interface OcbAgentSvc
request
- The request object containing the details to sendpublic GetAgentResponse getAgent(GetAgentRequest request)
OcbAgentSvc
Gets an Agent by identifier.
getAgent
in interface OcbAgentSvc
request
- The request object containing the details to sendpublic GetAgentDependencyResponse getAgentDependency(GetAgentDependencyRequest request)
OcbAgentSvc
Gets an AgentDependency by identifier.
getAgentDependency
in interface OcbAgentSvc
request
- The request object containing the details to sendpublic GetEnvironmentResponse getEnvironment(GetEnvironmentRequest request)
OcbAgentSvc
Gets a source environment by identifier.
getEnvironment
in interface OcbAgentSvc
request
- The request object containing the details to sendpublic GetPluginResponse getPlugin(GetPluginRequest request)
OcbAgentSvc
Gets a plugin by identifier.
getPlugin
in interface OcbAgentSvc
request
- The request object containing the details to sendpublic ListAgentDependenciesResponse listAgentDependencies(ListAgentDependenciesRequest request)
OcbAgentSvc
Returns a list of AgentDependencies such as AgentDependencyCollection.
listAgentDependencies
in interface OcbAgentSvc
request
- The request object containing the details to sendpublic ListAgentsResponse listAgents(ListAgentsRequest request)
OcbAgentSvc
Returns a list of Agents.
listAgents
in interface OcbAgentSvc
request
- The request object containing the details to sendpublic ListApplianceImagesResponse listApplianceImages(ListApplianceImagesRequest request)
OcbAgentSvc
Returns a list of Appliance Images.
listApplianceImages
in interface OcbAgentSvc
request
- The request object containing the details to sendpublic ListEnvironmentsResponse listEnvironments(ListEnvironmentsRequest request)
OcbAgentSvc
Returns a list of source environments.
listEnvironments
in interface OcbAgentSvc
request
- The request object containing the details to sendpublic RemoveAgentDependencyResponse removeAgentDependency(RemoveAgentDependencyRequest request)
OcbAgentSvc
Adds a dependency to the source environment. When provided, If-Match is checked against ETag values of the resource.
removeAgentDependency
in interface OcbAgentSvc
request
- The request object containing the details to sendpublic UpdateAgentResponse updateAgent(UpdateAgentRequest request)
OcbAgentSvc
Updates the Agent.
updateAgent
in interface OcbAgentSvc
request
- The request object containing the details to sendpublic UpdateAgentDependencyResponse updateAgentDependency(UpdateAgentDependencyRequest request)
OcbAgentSvc
Updates the AgentDependency.
updateAgentDependency
in interface OcbAgentSvc
request
- The request object containing the details to sendpublic UpdateEnvironmentResponse updateEnvironment(UpdateEnvironmentRequest request)
OcbAgentSvc
Updates the source environment.
updateEnvironment
in interface OcbAgentSvc
request
- The request object containing the details to sendpublic UpdatePluginResponse updatePlugin(UpdatePluginRequest request)
OcbAgentSvc
Updates the plugin.
updatePlugin
in interface OcbAgentSvc
request
- The request object containing the details to sendpublic OcbAgentSvcWaiters getWaiters()
OcbAgentSvc
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface OcbAgentSvc
public OcbAgentSvcPaginators getPaginators()
OcbAgentSvc
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 OcbAgentSvc
protected ClientConfigurator getDefaultConfigurator()
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint
- The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
public String getClientCommonLibraryVersion()
Copyright © 2016–2024. All rights reserved.