Package com.mypurecloud.sdk.v2.api

Class InfrastructureAsCodeApi

java.lang.Object
com.mypurecloud.sdk.v2.api.InfrastructureAsCodeApi
public class InfrastructureAsCodeApi extends Object

  • Constructor Details

    • InfrastructureAsCodeApi

      public InfrastructureAsCodeApi()

    • InfrastructureAsCodeApi

      public InfrastructureAsCodeApi(ApiClient apiClient)

  • Method Details

    • getInfrastructureascodeAccelerator

      public AcceleratorSpecification getInfrastructureascodeAccelerator(String acceleratorId, String preferredLanguage) throws IOException, ApiException
      Get information about an accelerator Get the complete metadata specification for an accelerator, including requirements and parameters.
      Parameters:
      acceleratorId - Accelerator ID (required)
      preferredLanguage - Preferred Language (optional, default to en-US)
      Returns:
      AcceleratorSpecification
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getInfrastructureascodeAcceleratorWithHttpInfo

      public ApiResponse<AcceleratorSpecification> getInfrastructureascodeAcceleratorWithHttpInfo(String acceleratorId, String preferredLanguage) throws IOException
      Get information about an accelerator Get the complete metadata specification for an accelerator, including requirements and parameters.
      Parameters:
      acceleratorId - Accelerator ID (required)
      preferredLanguage - Preferred Language (optional, default to en-US)
      Returns:
      AcceleratorSpecification
      Throws:
      IOException - if the request fails to be processed

    • getInfrastructureascodeAccelerator

      public AcceleratorSpecification getInfrastructureascodeAccelerator(GetInfrastructureascodeAcceleratorRequest request) throws IOException, ApiException
      Get information about an accelerator Get the complete metadata specification for an accelerator, including requirements and parameters.
      Parameters:
      request - The request object
      Returns:
      AcceleratorSpecification
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getInfrastructureascodeAccelerator

      public ApiResponse<AcceleratorSpecification> getInfrastructureascodeAccelerator(ApiRequest<Void> request) throws IOException
      Get information about an accelerator Get the complete metadata specification for an accelerator, including requirements and parameters.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getInfrastructureascodeAccelerators

      public AcceleratorList getInfrastructureascodeAccelerators(Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String name, String description, String origin, String type, String classification, String tags) throws IOException, ApiException
      Get a list of available accelerators Search for accelerators that can be run.
      Parameters:
      pageSize - The total page size requested (optional, default to 25)
      pageNumber - The page number requested (optional, default to 1)
      sortBy - variable name requested to sort by (optional)
      sortOrder - Sort order (optional, default to asc)
      name - Filter by name (optional)
      description - Filter by description (optional)
      origin - Filter by origin (optional)
      type - Filter by type (optional)
      classification - Filter by classification (optional)
      tags - Filter by tags (optional)
      Returns:
      AcceleratorList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getInfrastructureascodeAcceleratorsWithHttpInfo

      public ApiResponse<AcceleratorList> getInfrastructureascodeAcceleratorsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, String name, String description, String origin, String type, String classification, String tags) throws IOException
      Get a list of available accelerators Search for accelerators that can be run.
      Parameters:
      pageSize - The total page size requested (optional, default to 25)
      pageNumber - The page number requested (optional, default to 1)
      sortBy - variable name requested to sort by (optional)
      sortOrder - Sort order (optional, default to asc)
      name - Filter by name (optional)
      description - Filter by description (optional)
      origin - Filter by origin (optional)
      type - Filter by type (optional)
      classification - Filter by classification (optional)
      tags - Filter by tags (optional)
      Returns:
      AcceleratorList
      Throws:
      IOException - if the request fails to be processed

    • getInfrastructureascodeAccelerators

      public AcceleratorList getInfrastructureascodeAccelerators(GetInfrastructureascodeAcceleratorsRequest request) throws IOException, ApiException
      Get a list of available accelerators Search for accelerators that can be run.
      Parameters:
      request - The request object
      Returns:
      AcceleratorList
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getInfrastructureascodeAccelerators

      public ApiResponse<AcceleratorList> getInfrastructureascodeAccelerators(ApiRequest<Void> request) throws IOException
      Get a list of available accelerators Search for accelerators that can be run.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getInfrastructureascodeJob

      public InfrastructureascodeJob getInfrastructureascodeJob(String jobId, Boolean details) throws IOException, ApiException
      Get job status and results Get the execution status of a submitted job, optionally including results and error details.
      Parameters:
      jobId - Job ID (required)
      details - Include details of execution, including job results or error information (optional, default to false)
      Returns:
      InfrastructureascodeJob
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getInfrastructureascodeJobWithHttpInfo

      public ApiResponse<InfrastructureascodeJob> getInfrastructureascodeJobWithHttpInfo(String jobId, Boolean details) throws IOException
      Get job status and results Get the execution status of a submitted job, optionally including results and error details.
      Parameters:
      jobId - Job ID (required)
      details - Include details of execution, including job results or error information (optional, default to false)
      Returns:
      InfrastructureascodeJob
      Throws:
      IOException - if the request fails to be processed

    • getInfrastructureascodeJob

      public InfrastructureascodeJob getInfrastructureascodeJob(GetInfrastructureascodeJobRequest request) throws IOException, ApiException
      Get job status and results Get the execution status of a submitted job, optionally including results and error details.
      Parameters:
      request - The request object
      Returns:
      InfrastructureascodeJob
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getInfrastructureascodeJob

      public ApiResponse<InfrastructureascodeJob> getInfrastructureascodeJob(ApiRequest<Void> request) throws IOException
      Get job status and results Get the execution status of a submitted job, optionally including results and error details.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getInfrastructureascodeJobs

      public InfrastructureascodeJob getInfrastructureascodeJobs(Integer maxResults, Boolean includeErrors, String sortBy, String sortOrder, String acceleratorId, String submittedBy, String status) throws IOException, ApiException
      Get job history Get a history of submitted jobs, optionally including error messages.
      Parameters:
      maxResults - Number of jobs to show (optional, default to 1)
      includeErrors - Include error messages (optional, default to false)
      sortBy - Sort by (optional, default to dateSubmitted)
      sortOrder - Sort order (optional, default to desc)
      acceleratorId - Find only jobs associated with this accelerator (optional)
      submittedBy - Find only jobs submitted by this user (optional)
      status - Find only jobs in this state (optional)
      Returns:
      InfrastructureascodeJob
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getInfrastructureascodeJobsWithHttpInfo

      public ApiResponse<InfrastructureascodeJob> getInfrastructureascodeJobsWithHttpInfo(Integer maxResults, Boolean includeErrors, String sortBy, String sortOrder, String acceleratorId, String submittedBy, String status) throws IOException
      Get job history Get a history of submitted jobs, optionally including error messages.
      Parameters:
      maxResults - Number of jobs to show (optional, default to 1)
      includeErrors - Include error messages (optional, default to false)
      sortBy - Sort by (optional, default to dateSubmitted)
      sortOrder - Sort order (optional, default to desc)
      acceleratorId - Find only jobs associated with this accelerator (optional)
      submittedBy - Find only jobs submitted by this user (optional)
      status - Find only jobs in this state (optional)
      Returns:
      InfrastructureascodeJob
      Throws:
      IOException - if the request fails to be processed

    • getInfrastructureascodeJobs

      public InfrastructureascodeJob getInfrastructureascodeJobs(GetInfrastructureascodeJobsRequest request) throws IOException, ApiException
      Get job history Get a history of submitted jobs, optionally including error messages.
      Parameters:
      request - The request object
      Returns:
      InfrastructureascodeJob
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getInfrastructureascodeJobs

      public ApiResponse<InfrastructureascodeJob> getInfrastructureascodeJobs(ApiRequest<Void> request) throws IOException
      Get job history Get a history of submitted jobs, optionally including error messages.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postInfrastructureascodeJobs

      public InfrastructureascodeJob postInfrastructureascodeJobs(AcceleratorInput body) throws IOException, ApiException
      Create a Job Create and submit a job for remote execution or see job planning results.
      Parameters:
      body - (required)
      Returns:
      InfrastructureascodeJob
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postInfrastructureascodeJobsWithHttpInfo

      public ApiResponse<InfrastructureascodeJob> postInfrastructureascodeJobsWithHttpInfo(AcceleratorInput body) throws IOException
      Create a Job Create and submit a job for remote execution or see job planning results.
      Parameters:
      body - (required)
      Returns:
      InfrastructureascodeJob
      Throws:
      IOException - if the request fails to be processed

    • postInfrastructureascodeJobs

      public InfrastructureascodeJob postInfrastructureascodeJobs(PostInfrastructureascodeJobsRequest request) throws IOException, ApiException
      Create a Job Create and submit a job for remote execution or see job planning results.
      Parameters:
      request - The request object
      Returns:
      InfrastructureascodeJob
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postInfrastructureascodeJobs

      public ApiResponse<InfrastructureascodeJob> postInfrastructureascodeJobs(ApiRequest<AcceleratorInput> request) throws IOException
      Create a Job Create and submit a job for remote execution or see job planning results.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed