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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpaApi.GetSPARecommendationsOptionalParameters Manage optional parameters to getSPARecommendations.
static class	SpaApi.GetSPARecommendationsWithShardOptionalParameters Manage optional parameters to getSPARecommendationsWithShard.

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 service) Get SPA Recommendations.
RecommendationDocument	getSPARecommendations(String service, SpaApi.GetSPARecommendationsOptionalParameters parameters) Get SPA Recommendations.
CompletableFuture<RecommendationDocument>	getSPARecommendationsAsync(String service) Get SPA Recommendations.
CompletableFuture<RecommendationDocument>	getSPARecommendationsAsync(String service, SpaApi.GetSPARecommendationsOptionalParameters parameters) Get SPA Recommendations.
ApiResponse<RecommendationDocument>	getSPARecommendationsWithHttpInfo(String service, SpaApi.GetSPARecommendationsOptionalParameters parameters) This endpoint is currently experimental and restricted to Datadog internal use only.
CompletableFuture<ApiResponse<RecommendationDocument>>	getSPARecommendationsWithHttpInfoAsync(String service, SpaApi.GetSPARecommendationsOptionalParameters parameters) Get SPA Recommendations.
RecommendationDocument	getSPARecommendationsWithShard(String shard, String service) Get SPA Recommendations with a shard parameter.
RecommendationDocument	getSPARecommendationsWithShard(String shard, String service, SpaApi.GetSPARecommendationsWithShardOptionalParameters parameters) Get SPA Recommendations with a shard parameter.
CompletableFuture<RecommendationDocument>	getSPARecommendationsWithShardAsync(String shard, String service) Get SPA Recommendations with a shard parameter.
CompletableFuture<RecommendationDocument>	getSPARecommendationsWithShardAsync(String shard, String service, SpaApi.GetSPARecommendationsWithShardOptionalParameters parameters) Get SPA Recommendations with a shard parameter.
ApiResponse<RecommendationDocument>	getSPARecommendationsWithShardWithHttpInfo(String shard, String service, SpaApi.GetSPARecommendationsWithShardOptionalParameters parameters) This endpoint is currently experimental and restricted to Datadog internal use only.
CompletableFuture<ApiResponse<RecommendationDocument>>	getSPARecommendationsWithShardWithHttpInfoAsync(String shard, String service, SpaApi.GetSPARecommendationsWithShardOptionalParameters parameters) Get SPA Recommendations with a shard parameter.
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 service)
                                             throws ApiException

Get SPA Recommendations.

See getSPARecommendationsWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.SpaApi.GetSPARecommendationsOptionalParameters).

Parameters:

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 service)

Get SPA Recommendations.

See getSPARecommendationsWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.SpaApi.GetSPARecommendationsOptionalParameters).

Parameters:

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

Returns:

CompletableFuture<RecommendationDocument>

getSPARecommendations

public RecommendationDocument getSPARecommendations(String service,
                                                    SpaApi.GetSPARecommendationsOptionalParameters parameters)
                                             throws ApiException

Get SPA Recommendations.

See getSPARecommendationsWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.SpaApi.GetSPARecommendationsOptionalParameters).

Parameters:

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

parameters - Optional parameters for the request.

Returns:

RecommendationDocument

Throws:

ApiException - if fails to make API call

getSPARecommendationsAsync

public CompletableFuture<RecommendationDocument> getSPARecommendationsAsync(String service,
                                                                            SpaApi.GetSPARecommendationsOptionalParameters parameters)

Get SPA Recommendations.

See getSPARecommendationsWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.SpaApi.GetSPARecommendationsOptionalParameters).

Parameters:

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

parameters - Optional parameters for the request.

Returns:

CompletableFuture<RecommendationDocument>

getSPARecommendationsWithHttpInfo

public ApiResponse<RecommendationDocument> getSPARecommendationsWithHttpInfo(String service,
                                                                             SpaApi.GetSPARecommendationsOptionalParameters parameters)
                                                                      throws ApiException

This endpoint is currently experimental and restricted to Datadog internal use only. Retrieve resource recommendations for a Spark job. The caller (Spark Gateway or DJM UI) provides a service name and SPA returns structured recommendations for driver and executor resources. The version with a shard should be preferred, where possible, as it gives more accurate results.

Parameters:

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

parameters - Optional parameters for the request.

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 service,
                                                                                                     SpaApi.GetSPARecommendationsOptionalParameters parameters)

Get SPA Recommendations.

See getSPARecommendationsWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.SpaApi.GetSPARecommendationsOptionalParameters).

Parameters:

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

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<RecommendationDocument>>

getSPARecommendationsWithShard

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

Get SPA Recommendations with a shard parameter.

See getSPARecommendationsWithShardWithHttpInfo(java.lang.String, java.lang.String, com.datadog.api.client.v2.api.SpaApi.GetSPARecommendationsWithShardOptionalParameters).

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

getSPARecommendationsWithShardAsync

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

Get SPA Recommendations with a shard parameter.

See getSPARecommendationsWithShardWithHttpInfoAsync(java.lang.String, java.lang.String, com.datadog.api.client.v2.api.SpaApi.GetSPARecommendationsWithShardOptionalParameters).

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>

getSPARecommendationsWithShard

public RecommendationDocument getSPARecommendationsWithShard(String shard,
                                                             String service,
                                                             SpaApi.GetSPARecommendationsWithShardOptionalParameters parameters)
                                                      throws ApiException

Get SPA Recommendations with a shard parameter.

See getSPARecommendationsWithShardWithHttpInfo(java.lang.String, java.lang.String, com.datadog.api.client.v2.api.SpaApi.GetSPARecommendationsWithShardOptionalParameters).

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)

parameters - Optional parameters for the request.

Returns:

RecommendationDocument

Throws:

ApiException - if fails to make API call

getSPARecommendationsWithShardAsync

public CompletableFuture<RecommendationDocument> getSPARecommendationsWithShardAsync(String shard,
                                                                                     String service,
                                                                                     SpaApi.GetSPARecommendationsWithShardOptionalParameters parameters)

Get SPA Recommendations with a shard parameter.

See getSPARecommendationsWithShardWithHttpInfoAsync(java.lang.String, java.lang.String, com.datadog.api.client.v2.api.SpaApi.GetSPARecommendationsWithShardOptionalParameters).

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)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<RecommendationDocument>

getSPARecommendationsWithShardWithHttpInfo

public ApiResponse<RecommendationDocument> getSPARecommendationsWithShardWithHttpInfo(String shard,
                                                                                      String service,
                                                                                      SpaApi.GetSPARecommendationsWithShardOptionalParameters parameters)
                                                                               throws ApiException

This endpoint is currently experimental and restricted to Datadog internal use only. 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)

parameters - Optional parameters for the request.

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	-

getSPARecommendationsWithShardWithHttpInfoAsync

public CompletableFuture<ApiResponse<RecommendationDocument>> getSPARecommendationsWithShardWithHttpInfoAsync(String shard,
                                                                                                              String service,
                                                                                                              SpaApi.GetSPARecommendationsWithShardOptionalParameters parameters)

Get SPA Recommendations with a shard parameter.

See getSPARecommendationsWithShardWithHttpInfo(java.lang.String, java.lang.String, com.datadog.api.client.v2.api.SpaApi.GetSPARecommendationsWithShardOptionalParameters).

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)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<RecommendationDocument>>