Skip to content

Add partitioning_attributes and lookup_attributes to Log Archives spec #3917

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add partitioning_attributes and lookup_attributes to Log Archives spec #3917

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49957,10 +49957,24 @@ components:
If it is set to "false", the tags will be deleted when the logs are sent to the archive.
example: false
type: boolean
lookup_attributes:
description: An array of attributes to use as lookup keys for the archive.
example: ["trace_id", "user_id"]
items:
description: A lookup attribute name.
type: string
type: array
name:
description: The archive name.
example: Nginx Archive
type: string
partitioning_attributes:
description: An array of attributes to use as partition keys for the archive. The attribute used most frequently for querying should be first.
example: ["service", "status"]
items:
description: A partition attribute name.
type: string
type: array
query:
description: The archive query/filter. Logs matching this query are included in the archive.
example: source:nginx
Expand Down Expand Up @@ -50016,10 +50030,24 @@ components:
If it is set to "false", the tags will be deleted when the logs are sent to the archive.
example: false
type: boolean
lookup_attributes:
description: An array of attributes to use as lookup keys for the archive.
example: ["trace_id", "user_id"]
items:
description: A lookup attribute name.
type: string
type: array
name:
description: The archive name.
example: Nginx Archive
type: string
partitioning_attributes:
description: An array of attributes to use as partition keys for the archive. The attribute used most frequently for querying should be first.
example: ["service", "status"]
items:
description: A partition attribute name.
type: string
type: array
query:
description: The archive query/filter. Logs matching this query are included in the archive.
example: source:nginx
Expand Down
2 changes: 2 additions & 0 deletions examples/v2/logs-archives/CreateLogsArchive.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ public static void main(String[] args) {
.storageAccount("account-name")
.type(LogsArchiveDestinationAzureType.AZURE)))
.includeTags(false)
.lookupAttributes(Arrays.asList("trace_id", "user_id"))
.name("Nginx Archive")
.partitioningAttributes(Arrays.asList("service", "status"))
.query("source:nginx")
.rehydrationMaxScanSizeInGb(100L)
.rehydrationTags(Arrays.asList("team:intake", "team:app")))
Expand Down
2 changes: 2 additions & 0 deletions examples/v2/logs-archives/UpdateLogsArchive.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ public static void main(String[] args) {
.storageAccount("account-name")
.type(LogsArchiveDestinationAzureType.AZURE)))
.includeTags(false)
.lookupAttributes(Arrays.asList("trace_id", "user_id"))
.name("Nginx Archive")
.partitioningAttributes(Arrays.asList("service", "status"))
.query("source:nginx")
.rehydrationMaxScanSizeInGb(100L)
.rehydrationTags(Arrays.asList("team:intake", "team:app")))
Expand Down
75 changes: 75 additions & 0 deletions src/main/java/com/datadog/api/client/v2/model/LogsArchiveAttributes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@
LogsArchiveAttributes.JSON_PROPERTY_COMPRESSION_METHOD,
LogsArchiveAttributes.JSON_PROPERTY_DESTINATION,
LogsArchiveAttributes.JSON_PROPERTY_INCLUDE_TAGS,
LogsArchiveAttributes.JSON_PROPERTY_LOOKUP_ATTRIBUTES,
LogsArchiveAttributes.JSON_PROPERTY_NAME,
LogsArchiveAttributes.JSON_PROPERTY_PARTITIONING_ATTRIBUTES,
LogsArchiveAttributes.JSON_PROPERTY_QUERY,
LogsArchiveAttributes.JSON_PROPERTY_REHYDRATION_MAX_SCAN_SIZE_IN_GB,
LogsArchiveAttributes.JSON_PROPERTY_REHYDRATION_TAGS,
Expand All @@ -45,9 +47,15 @@ public class LogsArchiveAttributes {
public static final String JSON_PROPERTY_INCLUDE_TAGS = "include_tags";
private Boolean includeTags = false;

public static final String JSON_PROPERTY_LOOKUP_ATTRIBUTES = "lookup_attributes";
private List<String> lookupAttributes = null;

public static final String JSON_PROPERTY_NAME = "name";
private String name;

public static final String JSON_PROPERTY_PARTITIONING_ATTRIBUTES = "partitioning_attributes";
private List<String> partitioningAttributes = null;

public static final String JSON_PROPERTY_QUERY = "query";
private String query;

Expand Down Expand Up @@ -149,6 +157,35 @@ public void setIncludeTags(Boolean includeTags) {
this.includeTags = includeTags;
}

public LogsArchiveAttributes lookupAttributes(List<String> lookupAttributes) {
this.lookupAttributes = lookupAttributes;
return this;
}

public LogsArchiveAttributes addLookupAttributesItem(String lookupAttributesItem) {
if (this.lookupAttributes == null) {
this.lookupAttributes = new ArrayList<>();
}
this.lookupAttributes.add(lookupAttributesItem);
return this;
}

/**
* An array of attributes to use as lookup keys for the archive.
*
* @return lookupAttributes
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_LOOKUP_ATTRIBUTES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List<String> getLookupAttributes() {
return lookupAttributes;
}

public void setLookupAttributes(List<String> lookupAttributes) {
this.lookupAttributes = lookupAttributes;
}

public LogsArchiveAttributes name(String name) {
this.name = name;
return this;
Expand All @@ -169,6 +206,36 @@ public void setName(String name) {
this.name = name;
}

public LogsArchiveAttributes partitioningAttributes(List<String> partitioningAttributes) {
this.partitioningAttributes = partitioningAttributes;
return this;
}

public LogsArchiveAttributes addPartitioningAttributesItem(String partitioningAttributesItem) {
if (this.partitioningAttributes == null) {
this.partitioningAttributes = new ArrayList<>();
}
this.partitioningAttributes.add(partitioningAttributesItem);
return this;
}

/**
* An array of attributes to use as partition keys for the archive. The attribute used most
* frequently for querying should be first.
*
* @return partitioningAttributes
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_PARTITIONING_ATTRIBUTES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List<String> getPartitioningAttributes() {
return partitioningAttributes;
}

public void setPartitioningAttributes(List<String> partitioningAttributes) {
this.partitioningAttributes = partitioningAttributes;
}

public LogsArchiveAttributes query(String query) {
this.query = query;
return this;
Expand Down Expand Up @@ -334,7 +401,9 @@ public boolean equals(Object o) {
return Objects.equals(this.compressionMethod, logsArchiveAttributes.compressionMethod)
&& Objects.equals(this.destination, logsArchiveAttributes.destination)
&& Objects.equals(this.includeTags, logsArchiveAttributes.includeTags)
&& Objects.equals(this.lookupAttributes, logsArchiveAttributes.lookupAttributes)
&& Objects.equals(this.name, logsArchiveAttributes.name)
&& Objects.equals(this.partitioningAttributes, logsArchiveAttributes.partitioningAttributes)
&& Objects.equals(this.query, logsArchiveAttributes.query)
&& Objects.equals(
this.rehydrationMaxScanSizeInGb, logsArchiveAttributes.rehydrationMaxScanSizeInGb)
Expand All @@ -349,7 +418,9 @@ public int hashCode() {
compressionMethod,
destination,
includeTags,
lookupAttributes,
name,
partitioningAttributes,
query,
rehydrationMaxScanSizeInGb,
rehydrationTags,
Expand All @@ -364,7 +435,11 @@ public String toString() {
sb.append(" compressionMethod: ").append(toIndentedString(compressionMethod)).append("\n");
sb.append(" destination: ").append(toIndentedString(destination)).append("\n");
sb.append(" includeTags: ").append(toIndentedString(includeTags)).append("\n");
sb.append(" lookupAttributes: ").append(toIndentedString(lookupAttributes)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" partitioningAttributes: ")
.append(toIndentedString(partitioningAttributes))
.append("\n");
sb.append(" query: ").append(toIndentedString(query)).append("\n");
sb.append(" rehydrationMaxScanSizeInGb: ")
.append(toIndentedString(rehydrationMaxScanSizeInGb))
Expand Down
79 changes: 79 additions & 0 deletions src/main/java/com/datadog/api/client/v2/model/LogsArchiveCreateRequestAttributes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@
LogsArchiveCreateRequestAttributes.JSON_PROPERTY_COMPRESSION_METHOD,
LogsArchiveCreateRequestAttributes.JSON_PROPERTY_DESTINATION,
LogsArchiveCreateRequestAttributes.JSON_PROPERTY_INCLUDE_TAGS,
LogsArchiveCreateRequestAttributes.JSON_PROPERTY_LOOKUP_ATTRIBUTES,
LogsArchiveCreateRequestAttributes.JSON_PROPERTY_NAME,
LogsArchiveCreateRequestAttributes.JSON_PROPERTY_PARTITIONING_ATTRIBUTES,
LogsArchiveCreateRequestAttributes.JSON_PROPERTY_QUERY,
LogsArchiveCreateRequestAttributes.JSON_PROPERTY_REHYDRATION_MAX_SCAN_SIZE_IN_GB,
LogsArchiveCreateRequestAttributes.JSON_PROPERTY_REHYDRATION_TAGS
Expand All @@ -44,9 +46,15 @@ public class LogsArchiveCreateRequestAttributes {
public static final String JSON_PROPERTY_INCLUDE_TAGS = "include_tags";
private Boolean includeTags = false;

public static final String JSON_PROPERTY_LOOKUP_ATTRIBUTES = "lookup_attributes";
private List<String> lookupAttributes = null;

public static final String JSON_PROPERTY_NAME = "name";
private String name;

public static final String JSON_PROPERTY_PARTITIONING_ATTRIBUTES = "partitioning_attributes";
private List<String> partitioningAttributes = null;

public static final String JSON_PROPERTY_QUERY = "query";
private String query;

Expand Down Expand Up @@ -141,6 +149,35 @@ public void setIncludeTags(Boolean includeTags) {
this.includeTags = includeTags;
}

public LogsArchiveCreateRequestAttributes lookupAttributes(List<String> lookupAttributes) {
this.lookupAttributes = lookupAttributes;
return this;
}

public LogsArchiveCreateRequestAttributes addLookupAttributesItem(String lookupAttributesItem) {
if (this.lookupAttributes == null) {
this.lookupAttributes = new ArrayList<>();
}
this.lookupAttributes.add(lookupAttributesItem);
return this;
}

/**
* An array of attributes to use as lookup keys for the archive.
*
* @return lookupAttributes
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_LOOKUP_ATTRIBUTES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List<String> getLookupAttributes() {
return lookupAttributes;
}

public void setLookupAttributes(List<String> lookupAttributes) {
this.lookupAttributes = lookupAttributes;
}

public LogsArchiveCreateRequestAttributes name(String name) {
this.name = name;
return this;
Expand All @@ -161,6 +198,38 @@ public void setName(String name) {
this.name = name;
}

public LogsArchiveCreateRequestAttributes partitioningAttributes(
List<String> partitioningAttributes) {
this.partitioningAttributes = partitioningAttributes;
return this;
}

public LogsArchiveCreateRequestAttributes addPartitioningAttributesItem(
String partitioningAttributesItem) {
if (this.partitioningAttributes == null) {
this.partitioningAttributes = new ArrayList<>();
}
this.partitioningAttributes.add(partitioningAttributesItem);
return this;
}

/**
* An array of attributes to use as partition keys for the archive. The attribute used most
* frequently for querying should be first.
*
* @return partitioningAttributes
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_PARTITIONING_ATTRIBUTES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List<String> getPartitioningAttributes() {
return partitioningAttributes;
}

public void setPartitioningAttributes(List<String> partitioningAttributes) {
this.partitioningAttributes = partitioningAttributes;
}

public LogsArchiveCreateRequestAttributes query(String query) {
this.query = query;
return this;
Expand Down Expand Up @@ -304,7 +373,11 @@ public boolean equals(Object o) {
this.compressionMethod, logsArchiveCreateRequestAttributes.compressionMethod)
&& Objects.equals(this.destination, logsArchiveCreateRequestAttributes.destination)
&& Objects.equals(this.includeTags, logsArchiveCreateRequestAttributes.includeTags)
&& Objects.equals(
this.lookupAttributes, logsArchiveCreateRequestAttributes.lookupAttributes)
&& Objects.equals(this.name, logsArchiveCreateRequestAttributes.name)
&& Objects.equals(
this.partitioningAttributes, logsArchiveCreateRequestAttributes.partitioningAttributes)
&& Objects.equals(this.query, logsArchiveCreateRequestAttributes.query)
&& Objects.equals(
this.rehydrationMaxScanSizeInGb,
Expand All @@ -320,7 +393,9 @@ public int hashCode() {
compressionMethod,
destination,
includeTags,
lookupAttributes,
name,
partitioningAttributes,
query,
rehydrationMaxScanSizeInGb,
rehydrationTags,
Expand All @@ -334,7 +409,11 @@ public String toString() {
sb.append(" compressionMethod: ").append(toIndentedString(compressionMethod)).append("\n");
sb.append(" destination: ").append(toIndentedString(destination)).append("\n");
sb.append(" includeTags: ").append(toIndentedString(includeTags)).append("\n");
sb.append(" lookupAttributes: ").append(toIndentedString(lookupAttributes)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" partitioningAttributes: ")
.append(toIndentedString(partitioningAttributes))
.append("\n");
sb.append(" query: ").append(toIndentedString(query)).append("\n");
sb.append(" rehydrationMaxScanSizeInGb: ")
.append(toIndentedString(rehydrationMaxScanSizeInGb))
Expand Down
Loading
Loading