com.datadog.api.client.v2.api

Class SpaApi

java.lang.Object

com.datadog.api.client.v2.api.SpaApi

@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class SpaApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SpaApi()
SpaApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient() Get the API client.
RecommendationDocument	getSPARecommendations(String shard, String service) Get SPA Recommendations.
CompletableFuture<RecommendationDocument>	getSPARecommendationsAsync(String shard, String service) Get SPA Recommendations.
ApiResponse<RecommendationDocument>	getSPARecommendationsWithHttpInfo(String shard, String service) Retrieve resource recommendations for a Spark job.
CompletableFuture<ApiResponse<RecommendationDocument>>	getSPARecommendationsWithHttpInfoAsync(String shard, String service) Get SPA Recommendations.
void	setApiClient(ApiClient apiClient) Set the API client.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpaApi

public SpaApi()

SpaApi

public SpaApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

Get the API client.

Returns:

API client

setApiClient

public void setApiClient(ApiClient apiClient)

Set the API client.

Parameters:

apiClient - an instance of API client

getSPARecommendations

public RecommendationDocument getSPARecommendations(String shard,
                                                    String service)
                                             throws ApiException

Get SPA Recommendations.

See getSPARecommendationsWithHttpInfo(java.lang.String, java.lang.String).

Parameters:

shard - The shard tag for a spark job, which differentiates jobs within the same service that have different resource needs (required)

service - The service name for a spark job (required)

Returns:

RecommendationDocument

Throws:

ApiException - if fails to make API call

getSPARecommendationsAsync

public CompletableFuture<RecommendationDocument> getSPARecommendationsAsync(String shard,
                                                                            String service)

Get SPA Recommendations.

See getSPARecommendationsWithHttpInfoAsync(java.lang.String, java.lang.String).

Parameters:

shard - The shard tag for a spark job, which differentiates jobs within the same service that have different resource needs (required)

service - The service name for a spark job (required)

Returns:

CompletableFuture<RecommendationDocument>

getSPARecommendationsWithHttpInfo

public ApiResponse<RecommendationDocument> getSPARecommendationsWithHttpInfo(String shard,
                                                                             String service)
                                                                      throws ApiException

Retrieve resource recommendations for a Spark job. The caller (Spark Gateway or DJM UI) provides a service name and shard identifier, and SPA returns structured recommendations for driver and executor resources.

Parameters:

shard - The shard tag for a spark job, which differentiates jobs within the same service that have different resource needs (required)

service - The service name for a spark job (required)

Returns:

ApiResponse<RecommendationDocument>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

getSPARecommendationsWithHttpInfoAsync

public CompletableFuture<ApiResponse<RecommendationDocument>> getSPARecommendationsWithHttpInfoAsync(String shard,
                                                                                                     String service)

Get SPA Recommendations.

See getSPARecommendationsWithHttpInfo(java.lang.String, java.lang.String).

Parameters:

shard - The shard tag for a spark job, which differentiates jobs within the same service that have different resource needs (required)

service - The service name for a spark job (required)

Returns:

CompletableFuture<ApiResponse<RecommendationDocument>>