Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.apigee/v1.SecurityReport
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Submit a report request to be processed in the background. If the submission succeeds, the API returns a 200 status and an ID that refer to the report request. In addition to the HTTP status 200, the state
of “enqueued” means that the request succeeded.
Auto-naming is currently not supported for this resource.
Note - this resource’s API doesn’t support deletion. When deleted, the resource will persist
on Google Cloud even though it will be deleted from Pulumi state.
Create SecurityReport Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SecurityReport(name: string, args: SecurityReportArgs, opts?: CustomResourceOptions);
@overload
def SecurityReport(resource_name: str,
args: SecurityReportArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SecurityReport(resource_name: str,
opts: Optional[ResourceOptions] = None,
environment_id: Optional[str] = None,
time_range: Optional[Any] = None,
organization_id: Optional[str] = None,
group_by_time_unit: Optional[str] = None,
envgroup_hostname: Optional[str] = None,
filter: Optional[str] = None,
csv_delimiter: Optional[str] = None,
limit: Optional[int] = None,
metrics: Optional[Sequence[GoogleCloudApigeeV1SecurityReportQueryMetricArgs]] = None,
mime_type: Optional[str] = None,
display_name: Optional[str] = None,
report_definition_id: Optional[str] = None,
dimensions: Optional[Sequence[str]] = None)
func NewSecurityReport(ctx *Context, name string, args SecurityReportArgs, opts ...ResourceOption) (*SecurityReport, error)
public SecurityReport(string name, SecurityReportArgs args, CustomResourceOptions? opts = null)
public SecurityReport(String name, SecurityReportArgs args)
public SecurityReport(String name, SecurityReportArgs args, CustomResourceOptions options)
type: google-native:apigee/v1:SecurityReport
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args SecurityReportArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SecurityReportArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SecurityReportArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SecurityReportArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SecurityReportArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var securityReportResource = new GoogleNative.Apigee.V1.SecurityReport("securityReportResource", new()
{
EnvironmentId = "string",
TimeRange = "any",
OrganizationId = "string",
GroupByTimeUnit = "string",
EnvgroupHostname = "string",
Filter = "string",
CsvDelimiter = "string",
Limit = 0,
Metrics = new[]
{
new GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1SecurityReportQueryMetricArgs
{
Name = "string",
AggregationFunction = "string",
Alias = "string",
Operator = "string",
Value = "string",
},
},
MimeType = "string",
DisplayName = "string",
ReportDefinitionId = "string",
Dimensions = new[]
{
"string",
},
});
example, err := apigee.NewSecurityReport(ctx, "securityReportResource", &apigee.SecurityReportArgs{
EnvironmentId: pulumi.String("string"),
TimeRange: pulumi.Any("any"),
OrganizationId: pulumi.String("string"),
GroupByTimeUnit: pulumi.String("string"),
EnvgroupHostname: pulumi.String("string"),
Filter: pulumi.String("string"),
CsvDelimiter: pulumi.String("string"),
Limit: pulumi.Int(0),
Metrics: apigee.GoogleCloudApigeeV1SecurityReportQueryMetricArray{
&apigee.GoogleCloudApigeeV1SecurityReportQueryMetricArgs{
Name: pulumi.String("string"),
AggregationFunction: pulumi.String("string"),
Alias: pulumi.String("string"),
Operator: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
MimeType: pulumi.String("string"),
DisplayName: pulumi.String("string"),
ReportDefinitionId: pulumi.String("string"),
Dimensions: pulumi.StringArray{
pulumi.String("string"),
},
})
var securityReportResource = new SecurityReport("securityReportResource", SecurityReportArgs.builder()
.environmentId("string")
.timeRange("any")
.organizationId("string")
.groupByTimeUnit("string")
.envgroupHostname("string")
.filter("string")
.csvDelimiter("string")
.limit(0)
.metrics(GoogleCloudApigeeV1SecurityReportQueryMetricArgs.builder()
.name("string")
.aggregationFunction("string")
.alias("string")
.operator("string")
.value("string")
.build())
.mimeType("string")
.displayName("string")
.reportDefinitionId("string")
.dimensions("string")
.build());
security_report_resource = google_native.apigee.v1.SecurityReport("securityReportResource",
environment_id="string",
time_range="any",
organization_id="string",
group_by_time_unit="string",
envgroup_hostname="string",
filter="string",
csv_delimiter="string",
limit=0,
metrics=[{
"name": "string",
"aggregation_function": "string",
"alias": "string",
"operator": "string",
"value": "string",
}],
mime_type="string",
display_name="string",
report_definition_id="string",
dimensions=["string"])
const securityReportResource = new google_native.apigee.v1.SecurityReport("securityReportResource", {
environmentId: "string",
timeRange: "any",
organizationId: "string",
groupByTimeUnit: "string",
envgroupHostname: "string",
filter: "string",
csvDelimiter: "string",
limit: 0,
metrics: [{
name: "string",
aggregationFunction: "string",
alias: "string",
operator: "string",
value: "string",
}],
mimeType: "string",
displayName: "string",
reportDefinitionId: "string",
dimensions: ["string"],
});
type: google-native:apigee/v1:SecurityReport
properties:
csvDelimiter: string
dimensions:
- string
displayName: string
envgroupHostname: string
environmentId: string
filter: string
groupByTimeUnit: string
limit: 0
metrics:
- aggregationFunction: string
alias: string
name: string
operator: string
value: string
mimeType: string
organizationId: string
reportDefinitionId: string
timeRange: any
SecurityReport Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The SecurityReport resource accepts the following input properties:
- Environment
Id string - Organization
Id string - Time
Range object - Time range for the query. Can use the following predefined strings to specify the time range:
last60minutes
last24hours
last7days
Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" } - Csv
Delimiter string - Delimiter used in the CSV file, if
outputFormat
is set tocsv
. Defaults to the,
(comma) character. Supported delimiter characters include comma (,
), pipe (|
), and tab (\t
). - Dimensions List<string>
- A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
- Display
Name string - Security Report display name which users can specify.
- Envgroup
Hostname string - Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostSecurityReport where analytics data will be grouped by organization and hostname.
- Filter string
- Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
- Group
By stringTime Unit - Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
- Limit int
- Maximum number of rows that can be returned in the result.
- Metrics
List<Pulumi.
Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Security Report Query Metric> - A list of Metrics.
- Mime
Type string - Valid values include:
csv
orjson
. Defaults tojson
. Note: Configure the delimiter for CSV output using the csvDelimiter property. - Report
Definition stringId - Report Definition ID.
- Environment
Id string - Organization
Id string - Time
Range interface{} - Time range for the query. Can use the following predefined strings to specify the time range:
last60minutes
last24hours
last7days
Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" } - Csv
Delimiter string - Delimiter used in the CSV file, if
outputFormat
is set tocsv
. Defaults to the,
(comma) character. Supported delimiter characters include comma (,
), pipe (|
), and tab (\t
). - Dimensions []string
- A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
- Display
Name string - Security Report display name which users can specify.
- Envgroup
Hostname string - Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostSecurityReport where analytics data will be grouped by organization and hostname.
- Filter string
- Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
- Group
By stringTime Unit - Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
- Limit int
- Maximum number of rows that can be returned in the result.
- Metrics
[]Google
Cloud Apigee V1Security Report Query Metric Args - A list of Metrics.
- Mime
Type string - Valid values include:
csv
orjson
. Defaults tojson
. Note: Configure the delimiter for CSV output using the csvDelimiter property. - Report
Definition stringId - Report Definition ID.
- environment
Id String - organization
Id String - time
Range Object - Time range for the query. Can use the following predefined strings to specify the time range:
last60minutes
last24hours
last7days
Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" } - csv
Delimiter String - Delimiter used in the CSV file, if
outputFormat
is set tocsv
. Defaults to the,
(comma) character. Supported delimiter characters include comma (,
), pipe (|
), and tab (\t
). - dimensions List<String>
- A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
- display
Name String - Security Report display name which users can specify.
- envgroup
Hostname String - Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostSecurityReport where analytics data will be grouped by organization and hostname.
- filter String
- Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
- group
By StringTime Unit - Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
- limit Integer
- Maximum number of rows that can be returned in the result.
- metrics
List<Google
Cloud Apigee V1Security Report Query Metric> - A list of Metrics.
- mime
Type String - Valid values include:
csv
orjson
. Defaults tojson
. Note: Configure the delimiter for CSV output using the csvDelimiter property. - report
Definition StringId - Report Definition ID.
- environment
Id string - organization
Id string - time
Range any - Time range for the query. Can use the following predefined strings to specify the time range:
last60minutes
last24hours
last7days
Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" } - csv
Delimiter string - Delimiter used in the CSV file, if
outputFormat
is set tocsv
. Defaults to the,
(comma) character. Supported delimiter characters include comma (,
), pipe (|
), and tab (\t
). - dimensions string[]
- A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
- display
Name string - Security Report display name which users can specify.
- envgroup
Hostname string - Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostSecurityReport where analytics data will be grouped by organization and hostname.
- filter string
- Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
- group
By stringTime Unit - Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
- limit number
- Maximum number of rows that can be returned in the result.
- metrics
Google
Cloud Apigee V1Security Report Query Metric[] - A list of Metrics.
- mime
Type string - Valid values include:
csv
orjson
. Defaults tojson
. Note: Configure the delimiter for CSV output using the csvDelimiter property. - report
Definition stringId - Report Definition ID.
- environment_
id str - organization_
id str - time_
range Any - Time range for the query. Can use the following predefined strings to specify the time range:
last60minutes
last24hours
last7days
Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" } - csv_
delimiter str - Delimiter used in the CSV file, if
outputFormat
is set tocsv
. Defaults to the,
(comma) character. Supported delimiter characters include comma (,
), pipe (|
), and tab (\t
). - dimensions Sequence[str]
- A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
- display_
name str - Security Report display name which users can specify.
- envgroup_
hostname str - Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostSecurityReport where analytics data will be grouped by organization and hostname.
- filter str
- Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
- group_
by_ strtime_ unit - Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
- limit int
- Maximum number of rows that can be returned in the result.
- metrics
Sequence[Google
Cloud Apigee V1Security Report Query Metric Args] - A list of Metrics.
- mime_
type str - Valid values include:
csv
orjson
. Defaults tojson
. Note: Configure the delimiter for CSV output using the csvDelimiter property. - report_
definition_ strid - Report Definition ID.
- environment
Id String - organization
Id String - time
Range Any - Time range for the query. Can use the following predefined strings to specify the time range:
last60minutes
last24hours
last7days
Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" } - csv
Delimiter String - Delimiter used in the CSV file, if
outputFormat
is set tocsv
. Defaults to the,
(comma) character. Supported delimiter characters include comma (,
), pipe (|
), and tab (\t
). - dimensions List<String>
- A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
- display
Name String - Security Report display name which users can specify.
- envgroup
Hostname String - Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostSecurityReport where analytics data will be grouped by organization and hostname.
- filter String
- Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
- group
By StringTime Unit - Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
- limit Number
- Maximum number of rows that can be returned in the result.
- metrics List<Property Map>
- A list of Metrics.
- mime
Type String - Valid values include:
csv
orjson
. Defaults tojson
. Note: Configure the delimiter for CSV output using the csvDelimiter property. - report
Definition StringId - Report Definition ID.
Outputs
All input properties are implicitly available as output properties. Additionally, the SecurityReport resource produces the following output properties:
- Created string
- Creation time of the query.
- Error string
- Error is set when query fails.
- Execution
Time string - ExecutionTime is available only after the query is completed.
- Id string
- The provider-assigned unique ID for this managed resource.
- Query
Params Pulumi.Google Native. Apigee. V1. Outputs. Google Cloud Apigee V1Security Report Metadata Response - Contains information like metrics, dimenstions etc of the Security Report.
- Result
Pulumi.
Google Native. Apigee. V1. Outputs. Google Cloud Apigee V1Security Report Result Metadata Response - Result is available only after the query is completed.
- Result
File stringSize - ResultFileSize is available only after the query is completed.
- Result
Rows string - ResultRows is available only after the query is completed.
- Self string
- Self link of the query. Example:
/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
or following format if query is running at host level:/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
- State string
- Query state could be "enqueued", "running", "completed", "expired" and "failed".
- Updated string
- Last updated timestamp for the query.
- Created string
- Creation time of the query.
- Error string
- Error is set when query fails.
- Execution
Time string - ExecutionTime is available only after the query is completed.
- Id string
- The provider-assigned unique ID for this managed resource.
- Query
Params GoogleCloud Apigee V1Security Report Metadata Response - Contains information like metrics, dimenstions etc of the Security Report.
- Result
Google
Cloud Apigee V1Security Report Result Metadata Response - Result is available only after the query is completed.
- Result
File stringSize - ResultFileSize is available only after the query is completed.
- Result
Rows string - ResultRows is available only after the query is completed.
- Self string
- Self link of the query. Example:
/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
or following format if query is running at host level:/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
- State string
- Query state could be "enqueued", "running", "completed", "expired" and "failed".
- Updated string
- Last updated timestamp for the query.
- created String
- Creation time of the query.
- error String
- Error is set when query fails.
- execution
Time String - ExecutionTime is available only after the query is completed.
- id String
- The provider-assigned unique ID for this managed resource.
- query
Params GoogleCloud Apigee V1Security Report Metadata Response - Contains information like metrics, dimenstions etc of the Security Report.
- result
Google
Cloud Apigee V1Security Report Result Metadata Response - Result is available only after the query is completed.
- result
File StringSize - ResultFileSize is available only after the query is completed.
- result
Rows String - ResultRows is available only after the query is completed.
- self String
- Self link of the query. Example:
/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
or following format if query is running at host level:/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
- state String
- Query state could be "enqueued", "running", "completed", "expired" and "failed".
- updated String
- Last updated timestamp for the query.
- created string
- Creation time of the query.
- error string
- Error is set when query fails.
- execution
Time string - ExecutionTime is available only after the query is completed.
- id string
- The provider-assigned unique ID for this managed resource.
- query
Params GoogleCloud Apigee V1Security Report Metadata Response - Contains information like metrics, dimenstions etc of the Security Report.
- result
Google
Cloud Apigee V1Security Report Result Metadata Response - Result is available only after the query is completed.
- result
File stringSize - ResultFileSize is available only after the query is completed.
- result
Rows string - ResultRows is available only after the query is completed.
- self string
- Self link of the query. Example:
/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
or following format if query is running at host level:/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
- state string
- Query state could be "enqueued", "running", "completed", "expired" and "failed".
- updated string
- Last updated timestamp for the query.
- created str
- Creation time of the query.
- error str
- Error is set when query fails.
- execution_
time str - ExecutionTime is available only after the query is completed.
- id str
- The provider-assigned unique ID for this managed resource.
- query_
params GoogleCloud Apigee V1Security Report Metadata Response - Contains information like metrics, dimenstions etc of the Security Report.
- result
Google
Cloud Apigee V1Security Report Result Metadata Response - Result is available only after the query is completed.
- result_
file_ strsize - ResultFileSize is available only after the query is completed.
- result_
rows str - ResultRows is available only after the query is completed.
- self str
- Self link of the query. Example:
/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
or following format if query is running at host level:/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
- state str
- Query state could be "enqueued", "running", "completed", "expired" and "failed".
- updated str
- Last updated timestamp for the query.
- created String
- Creation time of the query.
- error String
- Error is set when query fails.
- execution
Time String - ExecutionTime is available only after the query is completed.
- id String
- The provider-assigned unique ID for this managed resource.
- query
Params Property Map - Contains information like metrics, dimenstions etc of the Security Report.
- result Property Map
- Result is available only after the query is completed.
- result
File StringSize - ResultFileSize is available only after the query is completed.
- result
Rows String - ResultRows is available only after the query is completed.
- self String
- Self link of the query. Example:
/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
or following format if query is running at host level:/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
- state String
- Query state could be "enqueued", "running", "completed", "expired" and "failed".
- updated String
- Last updated timestamp for the query.
Supporting Types
GoogleCloudApigeeV1SecurityReportMetadataResponse, GoogleCloudApigeeV1SecurityReportMetadataResponseArgs
- Dimensions List<string>
- Dimensions of the SecurityReport.
- End
Timestamp string - End timestamp of the query range.
- Metrics List<string>
- Metrics of the SecurityReport. Example: ["name:bot_count,func:sum,alias:sum_bot_count"]
- Mime
Type string - MIME type / Output format.
- Start
Timestamp string - Start timestamp of the query range.
- Time
Unit string - Query GroupBy time unit. Example: "seconds", "minute", "hour"
- Dimensions []string
- Dimensions of the SecurityReport.
- End
Timestamp string - End timestamp of the query range.
- Metrics []string
- Metrics of the SecurityReport. Example: ["name:bot_count,func:sum,alias:sum_bot_count"]
- Mime
Type string - MIME type / Output format.
- Start
Timestamp string - Start timestamp of the query range.
- Time
Unit string - Query GroupBy time unit. Example: "seconds", "minute", "hour"
- dimensions List<String>
- Dimensions of the SecurityReport.
- end
Timestamp String - End timestamp of the query range.
- metrics List<String>
- Metrics of the SecurityReport. Example: ["name:bot_count,func:sum,alias:sum_bot_count"]
- mime
Type String - MIME type / Output format.
- start
Timestamp String - Start timestamp of the query range.
- time
Unit String - Query GroupBy time unit. Example: "seconds", "minute", "hour"
- dimensions string[]
- Dimensions of the SecurityReport.
- end
Timestamp string - End timestamp of the query range.
- metrics string[]
- Metrics of the SecurityReport. Example: ["name:bot_count,func:sum,alias:sum_bot_count"]
- mime
Type string - MIME type / Output format.
- start
Timestamp string - Start timestamp of the query range.
- time
Unit string - Query GroupBy time unit. Example: "seconds", "minute", "hour"
- dimensions Sequence[str]
- Dimensions of the SecurityReport.
- end_
timestamp str - End timestamp of the query range.
- metrics Sequence[str]
- Metrics of the SecurityReport. Example: ["name:bot_count,func:sum,alias:sum_bot_count"]
- mime_
type str - MIME type / Output format.
- start_
timestamp str - Start timestamp of the query range.
- time_
unit str - Query GroupBy time unit. Example: "seconds", "minute", "hour"
- dimensions List<String>
- Dimensions of the SecurityReport.
- end
Timestamp String - End timestamp of the query range.
- metrics List<String>
- Metrics of the SecurityReport. Example: ["name:bot_count,func:sum,alias:sum_bot_count"]
- mime
Type String - MIME type / Output format.
- start
Timestamp String - Start timestamp of the query range.
- time
Unit String - Query GroupBy time unit. Example: "seconds", "minute", "hour"
GoogleCloudApigeeV1SecurityReportQueryMetric, GoogleCloudApigeeV1SecurityReportQueryMetricArgs
- Name string
- Metric name.
- Aggregation
Function string - Aggregation function: avg, min, max, or sum.
- Alias string
- Alias for the metric. Alias will be used to replace metric name in query results.
- Operator string
- One of
+
,-
,/
,%
,*
. - Value string
- Operand value should be provided when operator is set.
- Name string
- Metric name.
- Aggregation
Function string - Aggregation function: avg, min, max, or sum.
- Alias string
- Alias for the metric. Alias will be used to replace metric name in query results.
- Operator string
- One of
+
,-
,/
,%
,*
. - Value string
- Operand value should be provided when operator is set.
- name String
- Metric name.
- aggregation
Function String - Aggregation function: avg, min, max, or sum.
- alias String
- Alias for the metric. Alias will be used to replace metric name in query results.
- operator String
- One of
+
,-
,/
,%
,*
. - value String
- Operand value should be provided when operator is set.
- name string
- Metric name.
- aggregation
Function string - Aggregation function: avg, min, max, or sum.
- alias string
- Alias for the metric. Alias will be used to replace metric name in query results.
- operator string
- One of
+
,-
,/
,%
,*
. - value string
- Operand value should be provided when operator is set.
- name str
- Metric name.
- aggregation_
function str - Aggregation function: avg, min, max, or sum.
- alias str
- Alias for the metric. Alias will be used to replace metric name in query results.
- operator str
- One of
+
,-
,/
,%
,*
. - value str
- Operand value should be provided when operator is set.
- name String
- Metric name.
- aggregation
Function String - Aggregation function: avg, min, max, or sum.
- alias String
- Alias for the metric. Alias will be used to replace metric name in query results.
- operator String
- One of
+
,-
,/
,%
,*
. - value String
- Operand value should be provided when operator is set.
GoogleCloudApigeeV1SecurityReportResultMetadataResponse, GoogleCloudApigeeV1SecurityReportResultMetadataResponseArgs
- Expires string
- Expire_time is set to 7 days after report creation. Query result will be unaccessable after this time. Example: "2021-05-04T13:38:52-07:00"
- Self string
- Self link of the query results. Example:
/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result
or following format if query is running at host level:/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result
- Expires string
- Expire_time is set to 7 days after report creation. Query result will be unaccessable after this time. Example: "2021-05-04T13:38:52-07:00"
- Self string
- Self link of the query results. Example:
/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result
or following format if query is running at host level:/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result
- expires String
- Expire_time is set to 7 days after report creation. Query result will be unaccessable after this time. Example: "2021-05-04T13:38:52-07:00"
- self String
- Self link of the query results. Example:
/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result
or following format if query is running at host level:/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result
- expires string
- Expire_time is set to 7 days after report creation. Query result will be unaccessable after this time. Example: "2021-05-04T13:38:52-07:00"
- self string
- Self link of the query results. Example:
/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result
or following format if query is running at host level:/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result
- expires str
- Expire_time is set to 7 days after report creation. Query result will be unaccessable after this time. Example: "2021-05-04T13:38:52-07:00"
- self str
- Self link of the query results. Example:
/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result
or following format if query is running at host level:/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result
- expires String
- Expire_time is set to 7 days after report creation. Query result will be unaccessable after this time. Example: "2021-05-04T13:38:52-07:00"
- self String
- Self link of the query results. Example:
/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result
or following format if query is running at host level:/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.