Skip to content
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.

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

Update documentation for App Sec SCA #2386

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2024-07-26 18:27:51.623307",
"spec_repo_commit": "7e92b530"
"regenerated": "2024-07-26 19:06:13.274657",
"spec_repo_commit": "44cf4afe"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2024-07-26 18:27:51.641240",
"spec_repo_commit": "7e92b530"
"regenerated": "2024-07-26 19:06:13.294373",
"spec_repo_commit": "44cf4afe"
}
}
}
48 changes: 48 additions & 0 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4216,6 +4216,7 @@ components:
- profiled_host_usage
- rum_browser_mobile_sessions_usage
- rum_replay_sessions_usage
- sca_fargate_usage
- sds_scanned_bytes_usage
- serverless_apps_usage
- siem_analyzed_logs_add_on_usage
Expand Down Expand Up @@ -4288,6 +4289,7 @@ components:
- PROFILED_HOST_USAGE
- RUM_BROWSER_MOBILE_SESSIONS_USAGE
- RUM_REPLAY_SESSIONS_USAGE
- SCA_FARGATE_USAGE
- SDS_SCANNED_BYTES_USAGE
- SERVERLESS_APPS_USAGE
- SIEM_ANALYZED_LOGS_ADD_ON_USAGE
Expand Down Expand Up @@ -7991,6 +7993,8 @@ components:
- siem_ingested_bytes_percentage
- workflow_executions_usage
- workflow_executions_percentage
- sca_fargate_usage
- sca_fargate_percentage
- '*'
type: string
x-enum-varnames:
Expand Down Expand Up @@ -8130,6 +8134,8 @@ components:
- SIEM_INGESTED_BYTES_PERCENTAGE
- WORKFLOW_EXECUTIONS_USAGE
- WORKFLOW_EXECUTIONS_PERCENTAGE
- SCA_FARGATE_USAGE
- SCA_FARGATE_PERCENTAGE
- ALL
MonthlyUsageAttributionValues:
description: Fields in Usage Summary by tag(s).
Expand Down Expand Up @@ -8639,6 +8645,16 @@ components:
description: The total RUM Session Replay usage by tag(s).
format: double
type: number
sca_fargate_percentage:
description: The percentage of Software Composition Analysis Fargate task
usage by tag(s).
format: double
type: number
sca_fargate_usage:
description: The total Software Composition Analysis Fargate task usage
by tag(s).
format: double
type: number
sds_scanned_bytes_percentage:
description: The percentage of Sensitive Data Scanner usage by tag(s).
format: double
Expand Down Expand Up @@ -19256,6 +19272,17 @@ components:
1st, 2024).
format: int64
type: integer
sca_fargate_count_avg:
description: Shows the average of all Software Composition Analysis Fargate
tasks over all hours in the current date for the given org.
format: int64
type: integer
sca_fargate_count_hwm:
description: Shows the sum of the high-water marks of all Software Composition
Analysis Fargate tasks over all hours in the current date for the given
org.
format: int64
type: integer
sds_apm_scanned_bytes_sum:
description: Sum of all APM bytes scanned with sensitive data scanner over
all hours in the current date for all organizations.
Expand Down Expand Up @@ -19964,6 +19991,17 @@ components:
1st, 2024).
format: int64
type: integer
sca_fargate_count_avg:
description: Shows the average of all Software Composition Analysis Fargate
tasks over all hours in the current date for the given org.
format: int64
type: integer
sca_fargate_count_hwm:
description: Shows the sum of the high-water marks of all Software Composition
Analysis Fargate tasks over all hours in the current date for the given
org.
format: int64
type: integer
sds_apm_scanned_bytes_sum:
description: Sum of all APM bytes scanned with sensitive data scanner over
all hours in the current date for the given org.
Expand Down Expand Up @@ -20707,6 +20745,16 @@ components:
October 1st, 2024).
format: int64
type: integer
sca_fargate_count_avg_sum:
description: Shows the average of all Software Composition Analysis Fargate
tasks over all hours in the current months for all organizations.
format: int64
type: integer
sca_fargate_count_hwm_sum:
description: Shows the sum of the high-water marks of all Software Composition
Analysis Fargate tasks over all hours in the current months for all organizations.
format: int64
type: integer
sds_apm_scanned_bytes_sum:
description: Sum of all APM bytes scanned with sensitive data scanner in
the current month for all organizations.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ public class HourlyUsageAttributionUsageType extends ModelEnum<String> {
"profiled_host_usage",
"rum_browser_mobile_sessions_usage",
"rum_replay_sessions_usage",
"sca_fargate_usage",
"sds_scanned_bytes_usage",
"serverless_apps_usage",
"siem_analyzed_logs_add_on_usage",
Expand Down Expand Up @@ -222,6 +223,8 @@ public class HourlyUsageAttributionUsageType extends ModelEnum<String> {
new HourlyUsageAttributionUsageType("rum_browser_mobile_sessions_usage");
public static final HourlyUsageAttributionUsageType RUM_REPLAY_SESSIONS_USAGE =
new HourlyUsageAttributionUsageType("rum_replay_sessions_usage");
public static final HourlyUsageAttributionUsageType SCA_FARGATE_USAGE =
new HourlyUsageAttributionUsageType("sca_fargate_usage");
public static final HourlyUsageAttributionUsageType SDS_SCANNED_BYTES_USAGE =
new HourlyUsageAttributionUsageType("sds_scanned_bytes_usage");
public static final HourlyUsageAttributionUsageType SERVERLESS_APPS_USAGE =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,8 @@ public class MonthlyUsageAttributionSupportedMetrics extends ModelEnum<String> {
"siem_ingested_bytes_percentage",
"workflow_executions_usage",
"workflow_executions_percentage",
"sca_fargate_usage",
"sca_fargate_percentage",
"*"));

public static final MonthlyUsageAttributionSupportedMetrics API_USAGE =
Expand Down Expand Up @@ -449,6 +451,10 @@ public class MonthlyUsageAttributionSupportedMetrics extends ModelEnum<String> {
new MonthlyUsageAttributionSupportedMetrics("workflow_executions_usage");
public static final MonthlyUsageAttributionSupportedMetrics WORKFLOW_EXECUTIONS_PERCENTAGE =
new MonthlyUsageAttributionSupportedMetrics("workflow_executions_percentage");
public static final MonthlyUsageAttributionSupportedMetrics SCA_FARGATE_USAGE =
new MonthlyUsageAttributionSupportedMetrics("sca_fargate_usage");
public static final MonthlyUsageAttributionSupportedMetrics SCA_FARGATE_PERCENTAGE =
new MonthlyUsageAttributionSupportedMetrics("sca_fargate_percentage");
public static final MonthlyUsageAttributionSupportedMetrics ALL =
new MonthlyUsageAttributionSupportedMetrics("*");

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,8 @@
MonthlyUsageAttributionValues.JSON_PROPERTY_RUM_BROWSER_MOBILE_SESSIONS_USAGE,
MonthlyUsageAttributionValues.JSON_PROPERTY_RUM_REPLAY_SESSIONS_PERCENTAGE,
MonthlyUsageAttributionValues.JSON_PROPERTY_RUM_REPLAY_SESSIONS_USAGE,
MonthlyUsageAttributionValues.JSON_PROPERTY_SCA_FARGATE_PERCENTAGE,
MonthlyUsageAttributionValues.JSON_PROPERTY_SCA_FARGATE_USAGE,
MonthlyUsageAttributionValues.JSON_PROPERTY_SDS_SCANNED_BYTES_PERCENTAGE,
MonthlyUsageAttributionValues.JSON_PROPERTY_SDS_SCANNED_BYTES_USAGE,
MonthlyUsageAttributionValues.JSON_PROPERTY_SERVERLESS_APPS_PERCENTAGE,
Expand Down Expand Up @@ -569,6 +571,12 @@ public class MonthlyUsageAttributionValues {
public static final String JSON_PROPERTY_RUM_REPLAY_SESSIONS_USAGE = "rum_replay_sessions_usage";
private Double rumReplaySessionsUsage;

public static final String JSON_PROPERTY_SCA_FARGATE_PERCENTAGE = "sca_fargate_percentage";
private Double scaFargatePercentage;

public static final String JSON_PROPERTY_SCA_FARGATE_USAGE = "sca_fargate_usage";
private Double scaFargateUsage;

public static final String JSON_PROPERTY_SDS_SCANNED_BYTES_PERCENTAGE =
"sds_scanned_bytes_percentage";
private Double sdsScannedBytesPercentage;
Expand Down Expand Up @@ -3192,6 +3200,48 @@ public void setRumReplaySessionsUsage(Double rumReplaySessionsUsage) {
this.rumReplaySessionsUsage = rumReplaySessionsUsage;
}

public MonthlyUsageAttributionValues scaFargatePercentage(Double scaFargatePercentage) {
this.scaFargatePercentage = scaFargatePercentage;
return this;
}

/**
* The percentage of Software Composition Analysis Fargate task usage by tag(s).
*
* @return scaFargatePercentage
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_SCA_FARGATE_PERCENTAGE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Double getScaFargatePercentage() {
return scaFargatePercentage;
}

public void setScaFargatePercentage(Double scaFargatePercentage) {
this.scaFargatePercentage = scaFargatePercentage;
}

public MonthlyUsageAttributionValues scaFargateUsage(Double scaFargateUsage) {
this.scaFargateUsage = scaFargateUsage;
return this;
}

/**
* The total Software Composition Analysis Fargate task usage by tag(s).
*
* @return scaFargateUsage
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_SCA_FARGATE_USAGE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Double getScaFargateUsage() {
return scaFargateUsage;
}

public void setScaFargateUsage(Double scaFargateUsage) {
this.scaFargateUsage = scaFargateUsage;
}

public MonthlyUsageAttributionValues sdsScannedBytesPercentage(Double sdsScannedBytesPercentage) {
this.sdsScannedBytesPercentage = sdsScannedBytesPercentage;
return this;
Expand Down Expand Up @@ -3836,6 +3886,9 @@ public boolean equals(Object o) {
monthlyUsageAttributionValues.rumReplaySessionsPercentage)
&& Objects.equals(
this.rumReplaySessionsUsage, monthlyUsageAttributionValues.rumReplaySessionsUsage)
&& Objects.equals(
this.scaFargatePercentage, monthlyUsageAttributionValues.scaFargatePercentage)
&& Objects.equals(this.scaFargateUsage, monthlyUsageAttributionValues.scaFargateUsage)
&& Objects.equals(
this.sdsScannedBytesPercentage, monthlyUsageAttributionValues.sdsScannedBytesPercentage)
&& Objects.equals(
Expand Down Expand Up @@ -4000,6 +4053,8 @@ public int hashCode() {
rumBrowserMobileSessionsUsage,
rumReplaySessionsPercentage,
rumReplaySessionsUsage,
scaFargatePercentage,
scaFargateUsage,
sdsScannedBytesPercentage,
sdsScannedBytesUsage,
serverlessAppsPercentage,
Expand Down Expand Up @@ -4315,6 +4370,10 @@ public String toString() {
sb.append(" rumReplaySessionsUsage: ")
.append(toIndentedString(rumReplaySessionsUsage))
.append("\n");
sb.append(" scaFargatePercentage: ")
.append(toIndentedString(scaFargatePercentage))
.append("\n");
sb.append(" scaFargateUsage: ").append(toIndentedString(scaFargateUsage)).append("\n");
sb.append(" sdsScannedBytesPercentage: ")
.append(toIndentedString(sdsScannedBytesPercentage))
.append("\n");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,8 @@
UsageSummaryDate.JSON_PROPERTY_RUM_SESSION_COUNT_SUM,
UsageSummaryDate.JSON_PROPERTY_RUM_TOTAL_SESSION_COUNT_SUM,
UsageSummaryDate.JSON_PROPERTY_RUM_UNITS_SUM,
UsageSummaryDate.JSON_PROPERTY_SCA_FARGATE_COUNT_AVG,
UsageSummaryDate.JSON_PROPERTY_SCA_FARGATE_COUNT_HWM,
UsageSummaryDate.JSON_PROPERTY_SDS_APM_SCANNED_BYTES_SUM,
UsageSummaryDate.JSON_PROPERTY_SDS_EVENTS_SCANNED_BYTES_SUM,
UsageSummaryDate.JSON_PROPERTY_SDS_LOGS_SCANNED_BYTES_SUM,
Expand Down Expand Up @@ -537,6 +539,12 @@ public class UsageSummaryDate {
public static final String JSON_PROPERTY_RUM_UNITS_SUM = "rum_units_sum";
private Long rumUnitsSum;

public static final String JSON_PROPERTY_SCA_FARGATE_COUNT_AVG = "sca_fargate_count_avg";
private Long scaFargateCountAvg;

public static final String JSON_PROPERTY_SCA_FARGATE_COUNT_HWM = "sca_fargate_count_hwm";
private Long scaFargateCountHwm;

public static final String JSON_PROPERTY_SDS_APM_SCANNED_BYTES_SUM = "sds_apm_scanned_bytes_sum";
private Long sdsApmScannedBytesSum;

Expand Down Expand Up @@ -3062,6 +3070,50 @@ public void setRumUnitsSum(Long rumUnitsSum) {
this.rumUnitsSum = rumUnitsSum;
}

public UsageSummaryDate scaFargateCountAvg(Long scaFargateCountAvg) {
this.scaFargateCountAvg = scaFargateCountAvg;
return this;
}

/**
* Shows the average of all Software Composition Analysis Fargate tasks over all hours in the
* current date for the given org.
*
* @return scaFargateCountAvg
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_SCA_FARGATE_COUNT_AVG)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Long getScaFargateCountAvg() {
return scaFargateCountAvg;
}

public void setScaFargateCountAvg(Long scaFargateCountAvg) {
this.scaFargateCountAvg = scaFargateCountAvg;
}

public UsageSummaryDate scaFargateCountHwm(Long scaFargateCountHwm) {
this.scaFargateCountHwm = scaFargateCountHwm;
return this;
}

/**
* Shows the sum of the high-water marks of all Software Composition Analysis Fargate tasks over
* all hours in the current date for the given org.
*
* @return scaFargateCountHwm
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_SCA_FARGATE_COUNT_HWM)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Long getScaFargateCountHwm() {
return scaFargateCountHwm;
}

public void setScaFargateCountHwm(Long scaFargateCountHwm) {
this.scaFargateCountHwm = scaFargateCountHwm;
}

public UsageSummaryDate sdsApmScannedBytesSum(Long sdsApmScannedBytesSum) {
this.sdsApmScannedBytesSum = sdsApmScannedBytesSum;
return this;
Expand Down Expand Up @@ -3717,6 +3769,8 @@ public boolean equals(Object o) {
&& Objects.equals(this.rumSessionCountSum, usageSummaryDate.rumSessionCountSum)
&& Objects.equals(this.rumTotalSessionCountSum, usageSummaryDate.rumTotalSessionCountSum)
&& Objects.equals(this.rumUnitsSum, usageSummaryDate.rumUnitsSum)
&& Objects.equals(this.scaFargateCountAvg, usageSummaryDate.scaFargateCountAvg)
&& Objects.equals(this.scaFargateCountHwm, usageSummaryDate.scaFargateCountHwm)
&& Objects.equals(this.sdsApmScannedBytesSum, usageSummaryDate.sdsApmScannedBytesSum)
&& Objects.equals(this.sdsEventsScannedBytesSum, usageSummaryDate.sdsEventsScannedBytesSum)
&& Objects.equals(this.sdsLogsScannedBytesSum, usageSummaryDate.sdsLogsScannedBytesSum)
Expand Down Expand Up @@ -3867,6 +3921,8 @@ public int hashCode() {
rumSessionCountSum,
rumTotalSessionCountSum,
rumUnitsSum,
scaFargateCountAvg,
scaFargateCountHwm,
sdsApmScannedBytesSum,
sdsEventsScannedBytesSum,
sdsLogsScannedBytesSum,
Expand Down Expand Up @@ -4153,6 +4209,8 @@ public String toString() {
.append(toIndentedString(rumTotalSessionCountSum))
.append("\n");
sb.append(" rumUnitsSum: ").append(toIndentedString(rumUnitsSum)).append("\n");
sb.append(" scaFargateCountAvg: ").append(toIndentedString(scaFargateCountAvg)).append("\n");
sb.append(" scaFargateCountHwm: ").append(toIndentedString(scaFargateCountHwm)).append("\n");
sb.append(" sdsApmScannedBytesSum: ")
.append(toIndentedString(sdsApmScannedBytesSum))
.append("\n");
Expand Down
Loading
Loading