@Generated(value="OracleSDKGenerator", comments="API Version: 20180917") public class ResourceManagerClient extends Object implements ResourceManager
Modifier and Type | Class and Description |
---|---|
static class |
ResourceManagerClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for ResourceManager.
|
Constructor and Description |
---|
ResourceManagerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
ResourceManagerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
ResourceManagerClient(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.
|
ResourceManagerClient(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.
|
ResourceManagerClient(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.
|
ResourceManagerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
ResourceManagerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
ResourceManagerClient(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 ResourceManagerClient.Builder |
builder()
Create a builder for this client.
|
CancelJobResponse |
cancelJob(CancelJobRequest request)
Indicates the intention to cancel the specified job.
|
ChangeStackCompartmentResponse |
changeStackCompartment(ChangeStackCompartmentRequest request)
Moves a Stack and it’s associated Jobs into a different compartment.
|
void |
close() |
CreateJobResponse |
createJob(CreateJobRequest request)
Creates a job.
|
CreateStackResponse |
createStack(CreateStackRequest request)
Creates a stack in the specified comparment.
|
DeleteStackResponse |
deleteStack(DeleteStackRequest request)
Deletes the specified stack object.
|
GetJobResponse |
getJob(GetJobRequest request)
Returns the specified job along with the job details.
|
GetJobLogsResponse |
getJobLogs(GetJobLogsRequest request)
Returns log entries for the specified job in JSON format.
|
GetJobLogsContentResponse |
getJobLogsContent(GetJobLogsContentRequest request)
Returns raw log file for the specified job in text format.
|
GetJobTfConfigResponse |
getJobTfConfig(GetJobTfConfigRequest request)
Returns the Terraform configuration file for the specified job in .zip format.
|
GetJobTfStateResponse |
getJobTfState(GetJobTfStateRequest request)
Returns the Terraform state for the specified job.
|
ResourceManagerPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
|
GetStackResponse |
getStack(GetStackRequest request)
Gets a stack using the stack ID.
|
GetStackTfConfigResponse |
getStackTfConfig(GetStackTfConfigRequest request)
Returns the Terraform configuration file in .zip format for the specified stack.
|
GetStackTfStateResponse |
getStackTfState(GetStackTfStateRequest request)
Returns the Terraform state for the specified stack.
|
ResourceManagerWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
GetWorkRequestResponse |
getWorkRequest(GetWorkRequestRequest request)
Return the given work request.
|
ListJobsResponse |
listJobs(ListJobsRequest request)
Returns a list of jobs in a stack or compartment, ordered by time created.
|
ListStacksResponse |
listStacks(ListStacksRequest request)
Returns a list of stacks.
|
ListTerraformVersionsResponse |
listTerraformVersions(ListTerraformVersionsRequest request)
Returns a list of supported Terraform versions for use with stacks.
|
ListWorkRequestErrorsResponse |
listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Return a (paginated) list of errors for a given work request.
|
ListWorkRequestLogsResponse |
listWorkRequestLogs(ListWorkRequestLogsRequest request)
Return a (paginated) list of logs for a given work request.
|
ListWorkRequestsResponse |
listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a given compartment or for a given resource.
|
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’).
|
UpdateJobResponse |
updateJob(UpdateJobRequest request)
Updates the specified job.
|
UpdateStackResponse |
updateStack(UpdateStackRequest request)
Updates the specified stack object.
|
public static final Service SERVICE
Service instance for ResourceManager.
public ResourceManagerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public ResourceManagerClient(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 ResourceManagerClient(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 ResourceManagerClient(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 ResourceManagerClient(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 ResourceManagerClient(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 ResourceManagerClient(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 ResourceManagerClient(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 ThreadPoolExecutorpublic static ResourceManagerClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
ResourceManager
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface ResourceManager
endpoint
- The endpoint of the service.public void setRegion(Region region)
ResourceManager
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 ResourceManager
region
- The region of the service.public void setRegion(String regionId)
ResourceManager
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 ResourceManager
regionId
- The public region ID.public void close()
close
in interface AutoCloseable
public CancelJobResponse cancelJob(CancelJobRequest request)
ResourceManager
Indicates the intention to cancel the specified job. Cancellation of the job is not immediate, and may be delayed, or may not happen at all.
cancelJob
in interface ResourceManager
request
- The request object containing the details to sendpublic ChangeStackCompartmentResponse changeStackCompartment(ChangeStackCompartmentRequest request)
ResourceManager
Moves a Stack and it’s associated Jobs into a different compartment.
changeStackCompartment
in interface ResourceManager
request
- The request object containing the details to sendpublic CreateJobResponse createJob(CreateJobRequest request)
ResourceManager
Creates a job.
createJob
in interface ResourceManager
request
- The request object containing the details to sendpublic CreateStackResponse createStack(CreateStackRequest request)
ResourceManager
Creates a stack in the specified comparment. Specify the compartment using the compartment ID. For more information, see Create a Stack.
createStack
in interface ResourceManager
request
- The request object containing the details to sendpublic DeleteStackResponse deleteStack(DeleteStackRequest request)
ResourceManager
Deletes the specified stack object.
deleteStack
in interface ResourceManager
request
- The request object containing the details to sendpublic GetJobResponse getJob(GetJobRequest request)
ResourceManager
Returns the specified job along with the job details.
getJob
in interface ResourceManager
request
- The request object containing the details to sendpublic GetJobLogsResponse getJobLogs(GetJobLogsRequest request)
ResourceManager
Returns log entries for the specified job in JSON format.
getJobLogs
in interface ResourceManager
request
- The request object containing the details to sendpublic GetJobLogsContentResponse getJobLogsContent(GetJobLogsContentRequest request)
ResourceManager
Returns raw log file for the specified job in text format. Returns a maximum of 100,000 log entries.
getJobLogsContent
in interface ResourceManager
request
- The request object containing the details to sendpublic GetJobTfConfigResponse getJobTfConfig(GetJobTfConfigRequest request)
ResourceManager
Returns the Terraform configuration file for the specified job in .zip format. Returns an error if no zip file is found.
getJobTfConfig
in interface ResourceManager
request
- The request object containing the details to sendpublic GetJobTfStateResponse getJobTfState(GetJobTfStateRequest request)
ResourceManager
Returns the Terraform state for the specified job.
getJobTfState
in interface ResourceManager
request
- The request object containing the details to sendpublic GetStackResponse getStack(GetStackRequest request)
ResourceManager
Gets a stack using the stack ID.
getStack
in interface ResourceManager
request
- The request object containing the details to sendpublic GetStackTfConfigResponse getStackTfConfig(GetStackTfConfigRequest request)
ResourceManager
Returns the Terraform configuration file in .zip format for the specified stack. Returns an error if no zip file is found.
getStackTfConfig
in interface ResourceManager
request
- The request object containing the details to sendpublic GetStackTfStateResponse getStackTfState(GetStackTfStateRequest request)
ResourceManager
Returns the Terraform state for the specified stack.
getStackTfState
in interface ResourceManager
request
- The request object containing the details to sendpublic GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
ResourceManager
Return the given work request.
getWorkRequest
in interface ResourceManager
request
- The request object containing the details to sendpublic ListJobsResponse listJobs(ListJobsRequest request)
ResourceManager
Returns a list of jobs in a stack or compartment, ordered by time created.
- To list all jobs in a stack, provide the stack OCID. - To list all jobs in a compartment, provide the compartment OCID. - To return a specific job, provide the job OCID.
listJobs
in interface ResourceManager
request
- The request object containing the details to sendpublic ListStacksResponse listStacks(ListStacksRequest request)
ResourceManager
Returns a list of stacks. - If called using the compartment ID, returns all stacks in the specified compartment. - If called using the stack ID, returns the specified stack.
listStacks
in interface ResourceManager
request
- The request object containing the details to sendpublic ListTerraformVersionsResponse listTerraformVersions(ListTerraformVersionsRequest request)
ResourceManager
Returns a list of supported Terraform versions for use with stacks.
listTerraformVersions
in interface ResourceManager
request
- The request object containing the details to sendpublic ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
ResourceManager
Return a (paginated) list of errors for a given work request.
listWorkRequestErrors
in interface ResourceManager
request
- The request object containing the details to sendpublic ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
ResourceManager
Return a (paginated) list of logs for a given work request.
listWorkRequestLogs
in interface ResourceManager
request
- The request object containing the details to sendpublic ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
ResourceManager
Lists the work requests in a given compartment or for a given resource.
listWorkRequests
in interface ResourceManager
request
- The request object containing the details to sendpublic UpdateJobResponse updateJob(UpdateJobRequest request)
ResourceManager
Updates the specified job.
updateJob
in interface ResourceManager
request
- The request object containing the details to sendpublic UpdateStackResponse updateStack(UpdateStackRequest request)
ResourceManager
Updates the specified stack object. Use UpdateStack
when you update your Terraform configuration and want your changes to be reflected in the execution plan. For more information, see Update a Stack and Edit or Delete a Stack.
updateStack
in interface ResourceManager
request
- The request object containing the details to sendpublic ResourceManagerWaiters getWaiters()
ResourceManager
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface ResourceManager
public ResourceManagerPaginators getPaginators()
ResourceManager
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 ResourceManager
Copyright © 2016–2020. All rights reserved.