| Status Code | Description | Response Headers |
| 201 | App Created | - |
| 201 | Created | - |
| 400 | Bad Request | - |
| 403 | Forbidden | - |
| 429 | Too many requests | - |
| 429 | Too many requests | - |
See {@link #deleteAppWithHttpInfo}.
*
- * @param appId (required)
+ * @param appId The ID of the app to delete. (required)
* @return CompletableFuture<ApiResponse<DeleteAppResponse>>
*/
- public CompletableFuture See {@link #deployAppWithHttpInfo}.
*
- * @param appId (required)
+ * @param appId The ID of the app to deploy. (required)
* @return DeployAppResponse
* @throws ApiException if fails to make API call
*/
- public DeployAppResponse deployApp(String appId) throws ApiException {
+ public DeployAppResponse deployApp(UUID appId) throws ApiException {
return deployAppWithHttpInfo(appId).getData();
}
@@ -518,10 +517,10 @@ public DeployAppResponse deployApp(String appId) throws ApiException {
*
* See {@link #deployAppWithHttpInfoAsync}.
*
- * @param appId (required)
+ * @param appId The ID of the app to deploy. (required)
* @return CompletableFuture<DeployAppResponse>
*/
- public CompletableFuture See {@link #deployAppWithHttpInfo}.
*
- * @param appId (required)
+ * @param appId The ID of the app to deploy. (required)
* @return CompletableFuture<ApiResponse<DeployAppResponse>>
*/
- public CompletableFuture See {@link #disableAppWithHttpInfo}.
*
- * @param appId (required)
+ * @param appId The ID of the app to disable. (required)
* @return DisableAppResponse
* @throws ApiException if fails to make API call
*/
- public DisableAppResponse disableApp(String appId) throws ApiException {
+ public DisableAppResponse disableApp(UUID appId) throws ApiException {
return disableAppWithHttpInfo(appId).getData();
}
@@ -668,10 +668,10 @@ public DisableAppResponse disableApp(String appId) throws ApiException {
*
* See {@link #disableAppWithHttpInfoAsync}.
*
- * @param appId (required)
+ * @param appId The ID of the app to disable. (required)
* @return CompletableFuture<DisableAppResponse>
*/
- public CompletableFuture See {@link #disableAppWithHttpInfo}.
*
- * @param appId (required)
+ * @param appId The ID of the app to disable. (required)
* @return CompletableFuture<ApiResponse<DisableAppResponse>>
*/
public CompletableFuture See {@link #getAppWithHttpInfo}.
*
- * @param appId (required)
+ * @param appId The ID of the app to retrieve. (required)
* @return GetAppResponse
* @throws ApiException if fails to make API call
*/
- public GetAppResponse getApp(String appId) throws ApiException {
+ public GetAppResponse getApp(UUID appId) throws ApiException {
return getAppWithHttpInfo(appId, new GetAppOptionalParameters()).getData();
}
@@ -834,10 +838,10 @@ public GetAppResponse getApp(String appId) throws ApiException {
*
* See {@link #getAppWithHttpInfoAsync}.
*
- * @param appId (required)
+ * @param appId The ID of the app to retrieve. (required)
* @return CompletableFuture<GetAppResponse>
*/
- public CompletableFuture See {@link #getAppWithHttpInfo}.
*
- * @param appId (required)
+ * @param appId The ID of the app to retrieve. (required)
* @param parameters Optional parameters for the request.
* @return GetAppResponse
* @throws ApiException if fails to make API call
*/
- public GetAppResponse getApp(String appId, GetAppOptionalParameters parameters)
+ public GetAppResponse getApp(UUID appId, GetAppOptionalParameters parameters)
throws ApiException {
return getAppWithHttpInfo(appId, parameters).getData();
}
@@ -865,12 +869,12 @@ public GetAppResponse getApp(String appId, GetAppOptionalParameters parameters)
*
* See {@link #getAppWithHttpInfoAsync}.
*
- * @param appId (required)
+ * @param appId The ID of the app to retrieve. (required)
* @param parameters Optional parameters for the request.
* @return CompletableFuture<GetAppResponse>
*/
public CompletableFuture See {@link #getAppWithHttpInfo}.
*
- * @param appId (required)
+ * @param appId The ID of the app to retrieve. (required)
* @param parameters Optional parameters for the request.
* @return CompletableFuture<ApiResponse<GetAppResponse>>
*/
public CompletableFuture See {@link #updateAppWithHttpInfo}.
*
- * @param appId (required)
+ * @param appId The ID of the app to update. (required)
* @param body (required)
* @return UpdateAppResponse
* @throws ApiException if fails to make API call
*/
- public UpdateAppResponse updateApp(String appId, UpdateAppRequest body) throws ApiException {
+ public UpdateAppResponse updateApp(UUID appId, UpdateAppRequest body) throws ApiException {
return updateAppWithHttpInfo(appId, body).getData();
}
@@ -1376,11 +1381,11 @@ public UpdateAppResponse updateApp(String appId, UpdateAppRequest body) throws A
*
* See {@link #updateAppWithHttpInfoAsync}.
*
- * @param appId (required)
+ * @param appId The ID of the app to update. (required)
* @param body (required)
* @return CompletableFuture<UpdateAppResponse>
*/
- public CompletableFuture See {@link #updateAppWithHttpInfo}.
*
- * @param appId (required)
+ * @param appId The ID of the app to update. (required)
* @param body (required)
* @return CompletableFuture<ApiResponse<UpdateAppResponse>>
*/
public CompletableFuture 429 Too many requests - 429 Too many requests - latest and deployed can be used to retrieve the
+ * latest version or the published version, respectively. (optional)
* @return GetAppOptionalParameters
*/
public GetAppOptionalParameters version(String version) {
@@ -821,11 +825,11 @@ public GetAppOptionalParameters version(String version) {
*
* 429 Too many requests - AppBuilderEvent object. */
+/** An event on a UI component that triggers a response or action in an app. */
@JsonPropertyOrder({AppBuilderEvent.JSON_PROPERTY_NAME, AppBuilderEvent.JSON_PROPERTY_TYPE})
@jakarta.annotation.Generated(
value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
diff --git a/src/main/java/com/datadog/api/client/v2/model/AppMeta.java b/src/main/java/com/datadog/api/client/v2/model/AppMeta.java
index 0735550f0ee..4e01bec109c 100644
--- a/src/main/java/com/datadog/api/client/v2/model/AppMeta.java
+++ b/src/main/java/com/datadog/api/client/v2/model/AppMeta.java
@@ -12,6 +12,7 @@
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
+import java.time.OffsetDateTime;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
@@ -35,10 +36,10 @@
public class AppMeta {
@JsonIgnore public boolean unparsed = false;
public static final String JSON_PROPERTY_CREATED_AT = "created_at";
- private String createdAt;
+ private OffsetDateTime createdAt;
public static final String JSON_PROPERTY_DELETED_AT = "deleted_at";
- private String deletedAt;
+ private OffsetDateTime deletedAt;
public static final String JSON_PROPERTY_ORG_ID = "org_id";
private Long orgId;
@@ -47,7 +48,7 @@ public class AppMeta {
private String runAsUser;
public static final String JSON_PROPERTY_UPDATED_AT = "updated_at";
- private String updatedAt;
+ private OffsetDateTime updatedAt;
public static final String JSON_PROPERTY_UPDATED_SINCE_DEPLOYMENT = "updated_since_deployment";
private Boolean updatedSinceDeployment;
@@ -64,45 +65,45 @@ public class AppMeta {
public static final String JSON_PROPERTY_VERSION = "version";
private Long version;
- public AppMeta createdAt(String createdAt) {
+ public AppMeta createdAt(OffsetDateTime createdAt) {
this.createdAt = createdAt;
return this;
}
/**
- * The AppMeta created_at.
+ * Timestamp of when the app was created.
*
* @return createdAt
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_CREATED_AT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
- public String getCreatedAt() {
+ public OffsetDateTime getCreatedAt() {
return createdAt;
}
- public void setCreatedAt(String createdAt) {
+ public void setCreatedAt(OffsetDateTime createdAt) {
this.createdAt = createdAt;
}
- public AppMeta deletedAt(String deletedAt) {
+ public AppMeta deletedAt(OffsetDateTime deletedAt) {
this.deletedAt = deletedAt;
return this;
}
/**
- * The AppMeta deleted_at.
+ * Timestamp of when the app was deleted.
*
* @return deletedAt
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_DELETED_AT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
- public String getDeletedAt() {
+ public OffsetDateTime getDeletedAt() {
return deletedAt;
}
- public void setDeletedAt(String deletedAt) {
+ public void setDeletedAt(OffsetDateTime deletedAt) {
this.deletedAt = deletedAt;
}
@@ -112,7 +113,7 @@ public AppMeta orgId(Long orgId) {
}
/**
- * The AppMeta org_id.
+ * The Datadog organization ID that owns the app.
*
* @return orgId
*/
@@ -133,7 +134,8 @@ public AppMeta runAsUser(String runAsUser) {
}
/**
- * The AppMeta run_as_user.
+ * The user ID under which queries from the app are run. If unspecified, the app runs as the user
+ * who created the app.
*
* @return runAsUser
*/
@@ -148,24 +150,24 @@ public void setRunAsUser(String runAsUser) {
this.runAsUser = runAsUser;
}
- public AppMeta updatedAt(String updatedAt) {
+ public AppMeta updatedAt(OffsetDateTime updatedAt) {
this.updatedAt = updatedAt;
return this;
}
/**
- * The AppMeta updated_at.
+ * Timestamp of when the app was last updated.
*
* @return updatedAt
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_UPDATED_AT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
- public String getUpdatedAt() {
+ public OffsetDateTime getUpdatedAt() {
return updatedAt;
}
- public void setUpdatedAt(String updatedAt) {
+ public void setUpdatedAt(OffsetDateTime updatedAt) {
this.updatedAt = updatedAt;
}
@@ -175,7 +177,8 @@ public AppMeta updatedSinceDeployment(Boolean updatedSinceDeployment) {
}
/**
- * The AppMeta updated_since_deployment.
+ * Whether the app has been updated since it was last deployed. Deployed apps are pinned to a
+ * specific version and do not automatically update when the app is updated.
*
* @return updatedSinceDeployment
*/
@@ -196,7 +199,7 @@ public AppMeta userId(Long userId) {
}
/**
- * The AppMeta user_id.
+ * The ID of the user who created the app.
*
* @return userId
*/
@@ -217,7 +220,7 @@ public AppMeta userName(String userName) {
}
/**
- * The AppMeta user_name.
+ * The name (or email address) of the user who created the app.
*
* @return userName
*/
@@ -238,7 +241,7 @@ public AppMeta userUuid(UUID userUuid) {
}
/**
- * The AppMeta user_uuid.
+ * The UUID of the user who created the app.
*
* @return userUuid
*/
@@ -259,7 +262,7 @@ public AppMeta version(Long version) {
}
/**
- * The AppMeta version.
+ * The version number of the app. This starts at 1 and increments with each update.
*
* @return version
*/
diff --git a/src/main/java/com/datadog/api/client/v2/model/GetAppResponseRelationship.java b/src/main/java/com/datadog/api/client/v2/model/AppRelationship.java
similarity index 78%
rename from src/main/java/com/datadog/api/client/v2/model/GetAppResponseRelationship.java
rename to src/main/java/com/datadog/api/client/v2/model/AppRelationship.java
index bd0694c7da7..f676b68f37a 100644
--- a/src/main/java/com/datadog/api/client/v2/model/GetAppResponseRelationship.java
+++ b/src/main/java/com/datadog/api/client/v2/model/AppRelationship.java
@@ -18,14 +18,14 @@
import java.util.Map;
import java.util.Objects;
-/** The definition of GetAppResponseRelationship object. */
+/** The app's deployment relationship and custom connections. */
@JsonPropertyOrder({
- GetAppResponseRelationship.JSON_PROPERTY_CONNECTIONS,
- GetAppResponseRelationship.JSON_PROPERTY_DEPLOYMENT
+ AppRelationship.JSON_PROPERTY_CONNECTIONS,
+ AppRelationship.JSON_PROPERTY_DEPLOYMENT
})
@jakarta.annotation.Generated(
value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
-public class GetAppResponseRelationship {
+public class AppRelationship {
@JsonIgnore public boolean unparsed = false;
public static final String JSON_PROPERTY_CONNECTIONS = "connections";
private Listrelationship connections.
+ * Array of custom connections used by the app.
*
* @return connections
*/
@@ -66,14 +66,14 @@ public void setConnections(ListDeploymentRelationship object.
+ * Information pointing to the app's deployment status.
*
* @return deployment
*/
@@ -100,10 +100,10 @@ public void setDeployment(DeploymentRelationship deployment) {
*
* @param key The arbitrary key to set
* @param value The associated value
- * @return GetAppResponseRelationship
+ * @return AppRelationship
*/
@JsonAnySetter
- public GetAppResponseRelationship putAdditionalProperty(String key, Object value) {
+ public AppRelationship putAdditionalProperty(String key, Object value) {
if (this.additionalProperties == null) {
this.additionalProperties = new HashMapComponent object. */
+/**
+ * A UI component in an app. See https://docs.datadoghq.com/service_management/app_builder/components/
+ * for more details on the various components available.
+ */
@JsonPropertyOrder({
Component.JSON_PROPERTY_EVENTS,
Component.JSON_PROPERTY_ID,
@@ -80,7 +84,7 @@ public Component addEventsItem(AppBuilderEvent eventsItem) {
}
/**
- * The Component events.
+ * Events to listen for on the UI component.
*
* @return events
*/
@@ -101,7 +105,8 @@ public Component id(String id) {
}
/**
- * The Component id.
+ * The ID of the UI component. This property is deprecated, use name to identify
+ * individual components instead.
*
* @return id
*/
@@ -132,7 +137,7 @@ public Component name(String name) {
}
/**
- * The Component name.
+ * A unique identifier for this UI component. The name will also be visible in the app editor.
*
* @return name
*/
@@ -153,7 +158,10 @@ public Component properties(ComponentProperties properties) {
}
/**
- * The definition of ComponentProperties object.
+ * Properties of a UI component. Different component types can have its own additional unique
+ * properties. See https://docs.datadoghq.com/service_management/app_builder/components/
+ * for more details on the various components and their properties.
*
* @return properties
*/
@@ -174,7 +182,7 @@ public Component type(ComponentType type) {
}
/**
- * The definition of ComponentType object.
+ * The UI component type.
*
* @return type
*/
diff --git a/src/main/java/com/datadog/api/client/v2/model/ComponentGrid.java b/src/main/java/com/datadog/api/client/v2/model/ComponentGrid.java
index 2e8c1e91dd3..9ca4828141a 100644
--- a/src/main/java/com/datadog/api/client/v2/model/ComponentGrid.java
+++ b/src/main/java/com/datadog/api/client/v2/model/ComponentGrid.java
@@ -19,7 +19,7 @@
import java.util.Map;
import java.util.Objects;
-/** The definition of ComponentGrid object. */
+/** A grid component. */
@JsonPropertyOrder({
ComponentGrid.JSON_PROPERTY_EVENTS,
ComponentGrid.JSON_PROPERTY_ID,
@@ -79,7 +79,7 @@ public ComponentGrid addEventsItem(AppBuilderEvent eventsItem) {
}
/**
- * The ComponentGrid events.
+ * Events to listen for on the grid component.
*
* @return events
*/
@@ -100,7 +100,8 @@ public ComponentGrid id(String id) {
}
/**
- * The ComponentGrid id.
+ * The ID of the grid component. This property is deprecated, use name to identify
+ * individual components instead.
*
* @return id
*/
@@ -121,7 +122,7 @@ public ComponentGrid name(String name) {
}
/**
- * The ComponentGrid name.
+ * A unique identifier for this grid component. The name will also be visible in the app editor.
*
* @return name
*/
@@ -142,7 +143,7 @@ public ComponentGrid properties(ComponentGridProperties properties) {
}
/**
- * The definition of ComponentGridProperties object.
+ * Properties of a grid component.
*
* @return properties
*/
@@ -163,7 +164,7 @@ public ComponentGrid type(ComponentGridType type) {
}
/**
- * The definition of ComponentGridType object.
+ * The grid component type.
*
* @return type
*/
diff --git a/src/main/java/com/datadog/api/client/v2/model/ComponentGridProperties.java b/src/main/java/com/datadog/api/client/v2/model/ComponentGridProperties.java
index 111e2484083..4def4b3fa65 100644
--- a/src/main/java/com/datadog/api/client/v2/model/ComponentGridProperties.java
+++ b/src/main/java/com/datadog/api/client/v2/model/ComponentGridProperties.java
@@ -18,7 +18,7 @@
import java.util.Map;
import java.util.Objects;
-/** The definition of ComponentGridProperties object. */
+/** Properties of a grid component. */
@JsonPropertyOrder({
ComponentGridProperties.JSON_PROPERTY_BACKGROUND_COLOR,
ComponentGridProperties.JSON_PROPERTY_CHILDREN,
@@ -43,7 +43,7 @@ public ComponentGridProperties backgroundColor(String backgroundColor) {
}
/**
- * The ComponentGridProperties backgroundColor.
+ * The background color of the grid.
*
* @return backgroundColor
*/
@@ -76,7 +76,7 @@ public ComponentGridProperties addChildrenItem(Component childrenItem) {
}
/**
- * The ComponentGridProperties children.
+ * The child components of the grid.
*
* @return children
*/
@@ -98,7 +98,8 @@ public ComponentGridProperties isVisible(ComponentGridPropertiesIsVisible isVisi
}
/**
- * The definition of ComponentGridPropertiesIsVisible object.
+ * Whether the grid component and its children are visible. If a string, it should be a valid
+ * JavaScript expression that evaluates to a boolean.
*
* @return isVisible
*/
diff --git a/src/main/java/com/datadog/api/client/v2/model/ComponentGridType.java b/src/main/java/com/datadog/api/client/v2/model/ComponentGridType.java
index e469df77806..5884c9b8514 100644
--- a/src/main/java/com/datadog/api/client/v2/model/ComponentGridType.java
+++ b/src/main/java/com/datadog/api/client/v2/model/ComponentGridType.java
@@ -18,7 +18,7 @@
import java.util.HashSet;
import java.util.Set;
-/** The definition of ComponentGridType object. */
+/** The grid component type. */
@JsonSerialize(using = ComponentGridType.ComponentGridTypeSerializer.class)
public class ComponentGridType extends ModelEnumComponentProperties object. */
+/**
+ * Properties of a UI component. Different component types can have its own additional unique
+ * properties. See https://docs.datadoghq.com/service_management/app_builder/components/
+ * for more details on the various components and their properties.
+ */
@JsonPropertyOrder({
ComponentProperties.JSON_PROPERTY_CHILDREN,
ComponentProperties.JSON_PROPERTY_IS_VISIBLE
@@ -51,7 +56,7 @@ public ComponentProperties addChildrenItem(Component childrenItem) {
}
/**
- * The ComponentProperties children.
+ * The child components of the UI component.
*
* @return children
*/
@@ -73,7 +78,8 @@ public ComponentProperties isVisible(ComponentPropertiesIsVisible isVisible) {
}
/**
- * The definition of ComponentPropertiesIsVisible object.
+ * Whether the UI component is visible. If a string, it should be a valid JavaScript expression
+ * that evaluates to a boolean.
*
* @return isVisible
*/
diff --git a/src/main/java/com/datadog/api/client/v2/model/ComponentType.java b/src/main/java/com/datadog/api/client/v2/model/ComponentType.java
index c29c3223c05..3b054e00567 100644
--- a/src/main/java/com/datadog/api/client/v2/model/ComponentType.java
+++ b/src/main/java/com/datadog/api/client/v2/model/ComponentType.java
@@ -18,7 +18,7 @@
import java.util.HashSet;
import java.util.Set;
-/** The definition of ComponentType object. */
+/** The UI component type. */
@JsonSerialize(using = ComponentType.ComponentTypeSerializer.class)
public class ComponentType extends ModelEnumCreateAppRequest object. */
+/** A request object for creating a new app. */
@JsonPropertyOrder({CreateAppRequest.JSON_PROPERTY_DATA})
@jakarta.annotation.Generated(
value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
@@ -32,7 +32,7 @@ public CreateAppRequest data(CreateAppRequestData data) {
}
/**
- * The definition of CreateAppRequestData object.
+ * The data object containing the app definition.
*
* @return data
*/
diff --git a/src/main/java/com/datadog/api/client/v2/model/CreateAppRequestData.java b/src/main/java/com/datadog/api/client/v2/model/CreateAppRequestData.java
index e464271eed5..dfa2cf24660 100644
--- a/src/main/java/com/datadog/api/client/v2/model/CreateAppRequestData.java
+++ b/src/main/java/com/datadog/api/client/v2/model/CreateAppRequestData.java
@@ -17,7 +17,7 @@
import java.util.Map;
import java.util.Objects;
-/** The definition of CreateAppRequestData object. */
+/** The data object containing the app definition. */
@JsonPropertyOrder({
CreateAppRequestData.JSON_PROPERTY_ATTRIBUTES,
CreateAppRequestData.JSON_PROPERTY_TYPE
@@ -48,7 +48,7 @@ public CreateAppRequestData attributes(CreateAppRequestDataAttributes attributes
}
/**
- * The definition of CreateAppRequestDataAttributes object.
+ * App definition attributes such as name, description, and components.
*
* @return attributes
*/
@@ -70,7 +70,7 @@ public CreateAppRequestData type(CreateAppRequestDataType type) {
}
/**
- * The definition of CreateAppRequestDataType object.
+ * The app definition type.
*
* @return type
*/
diff --git a/src/main/java/com/datadog/api/client/v2/model/CreateAppRequestDataAttributes.java b/src/main/java/com/datadog/api/client/v2/model/CreateAppRequestDataAttributes.java
index 2d2990a1eda..da0eeb01d30 100644
--- a/src/main/java/com/datadog/api/client/v2/model/CreateAppRequestDataAttributes.java
+++ b/src/main/java/com/datadog/api/client/v2/model/CreateAppRequestDataAttributes.java
@@ -18,15 +18,13 @@
import java.util.Map;
import java.util.Objects;
-/** The definition of CreateAppRequestDataAttributes object. */
+/** App definition attributes such as name, description, and components. */
@JsonPropertyOrder({
CreateAppRequestDataAttributes.JSON_PROPERTY_COMPONENTS,
CreateAppRequestDataAttributes.JSON_PROPERTY_DESCRIPTION,
CreateAppRequestDataAttributes.JSON_PROPERTY_EMBEDDED_QUERIES,
- CreateAppRequestDataAttributes.JSON_PROPERTY_INPUT_SCHEMA,
CreateAppRequestDataAttributes.JSON_PROPERTY_NAME,
CreateAppRequestDataAttributes.JSON_PROPERTY_ROOT_INSTANCE_NAME,
- CreateAppRequestDataAttributes.JSON_PROPERTY_SCRIPTS,
CreateAppRequestDataAttributes.JSON_PROPERTY_TAGS
})
@jakarta.annotation.Generated(
@@ -42,18 +40,12 @@ public class CreateAppRequestDataAttributes {
public static final String JSON_PROPERTY_EMBEDDED_QUERIES = "embeddedQueries";
private List