Google Native

v0.27.0 published on Friday, Oct 21, 2022 by Pulumi

getSecurityReport

Get security report status If the query is still in progress, the state is set to “running” After the query has completed successfully, state is set to “completed”

Using getSecurityReport

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSecurityReport(args: GetSecurityReportArgs, opts?: InvokeOptions): Promise<GetSecurityReportResult>
function getSecurityReportOutput(args: GetSecurityReportOutputArgs, opts?: InvokeOptions): Output<GetSecurityReportResult>
def get_security_report(environment_id: Optional[str] = None,
                        organization_id: Optional[str] = None,
                        security_report_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetSecurityReportResult
def get_security_report_output(environment_id: Optional[pulumi.Input[str]] = None,
                        organization_id: Optional[pulumi.Input[str]] = None,
                        security_report_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetSecurityReportResult]
func LookupSecurityReport(ctx *Context, args *LookupSecurityReportArgs, opts ...InvokeOption) (*LookupSecurityReportResult, error)
func LookupSecurityReportOutput(ctx *Context, args *LookupSecurityReportOutputArgs, opts ...InvokeOption) LookupSecurityReportResultOutput

> Note: This function is named LookupSecurityReport in the Go SDK.

public static class GetSecurityReport 
{
    public static Task<GetSecurityReportResult> InvokeAsync(GetSecurityReportArgs args, InvokeOptions? opts = null)
    public static Output<GetSecurityReportResult> Invoke(GetSecurityReportInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetSecurityReportResult> getSecurityReport(GetSecurityReportArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: google-native:apigee/v1:getSecurityReport
  arguments:
    # arguments dictionary

The following arguments are supported:

getSecurityReport Result

The following output properties are available:

Created string

Creation time of the query.

DisplayName string

Display Name specified by the user.

EnvgroupHostname string

Hostname is available only when query is executed at host level.

Error string

Error is set when query fails.

ExecutionTime string

ExecutionTime is available only after the query is completed.

QueryParams Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1SecurityReportMetadataResponse

Contains information like metrics, dimenstions etc of the Security Report.

ReportDefinitionId string

Report Definition ID.

Result Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1SecurityReportResultMetadataResponse

Result is available only after the query is completed.

ResultFileSize string

ResultFileSize is available only after the query is completed.

ResultRows 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", "failed".

Updated string

Last updated timestamp for the query.

Created string

Creation time of the query.

DisplayName string

Display Name specified by the user.

EnvgroupHostname string

Hostname is available only when query is executed at host level.

Error string

Error is set when query fails.

ExecutionTime string

ExecutionTime is available only after the query is completed.

QueryParams GoogleCloudApigeeV1SecurityReportMetadataResponse

Contains information like metrics, dimenstions etc of the Security Report.

ReportDefinitionId string

Report Definition ID.

Result GoogleCloudApigeeV1SecurityReportResultMetadataResponse

Result is available only after the query is completed.

ResultFileSize string

ResultFileSize is available only after the query is completed.

ResultRows 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", "failed".

Updated string

Last updated timestamp for the query.

created String

Creation time of the query.

displayName String

Display Name specified by the user.

envgroupHostname String

Hostname is available only when query is executed at host level.

error String

Error is set when query fails.

executionTime String

ExecutionTime is available only after the query is completed.

queryParams GoogleCloudApigeeV1SecurityReportMetadataResponse

Contains information like metrics, dimenstions etc of the Security Report.

reportDefinitionId String

Report Definition ID.

result GoogleCloudApigeeV1SecurityReportResultMetadataResponse

Result is available only after the query is completed.

resultFileSize String

ResultFileSize is available only after the query is completed.

resultRows 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", "failed".

updated String

Last updated timestamp for the query.

created string

Creation time of the query.

displayName string

Display Name specified by the user.

envgroupHostname string

Hostname is available only when query is executed at host level.

error string

Error is set when query fails.

executionTime string

ExecutionTime is available only after the query is completed.

queryParams GoogleCloudApigeeV1SecurityReportMetadataResponse

Contains information like metrics, dimenstions etc of the Security Report.

reportDefinitionId string

Report Definition ID.

result GoogleCloudApigeeV1SecurityReportResultMetadataResponse

Result is available only after the query is completed.

resultFileSize string

ResultFileSize is available only after the query is completed.

resultRows 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", "failed".

updated string

Last updated timestamp for the query.

created str

Creation time of the query.

display_name str

Display Name specified by the user.

envgroup_hostname str

Hostname is available only when query is executed at host level.

error str

Error is set when query fails.

execution_time str

ExecutionTime is available only after the query is completed.

query_params GoogleCloudApigeeV1SecurityReportMetadataResponse

Contains information like metrics, dimenstions etc of the Security Report.

report_definition_id str

Report Definition ID.

result GoogleCloudApigeeV1SecurityReportResultMetadataResponse

Result is available only after the query is completed.

result_file_size str

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", "failed".

updated str

Last updated timestamp for the query.

created String

Creation time of the query.

displayName String

Display Name specified by the user.

envgroupHostname String

Hostname is available only when query is executed at host level.

error String

Error is set when query fails.

executionTime String

ExecutionTime is available only after the query is completed.

queryParams Property Map

Contains information like metrics, dimenstions etc of the Security Report.

reportDefinitionId String

Report Definition ID.

result Property Map

Result is available only after the query is completed.

resultFileSize String

ResultFileSize is available only after the query is completed.

resultRows 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", "failed".

updated String

Last updated timestamp for the query.

Supporting Types

GoogleCloudApigeeV1SecurityReportMetadataResponse

Dimensions List<string>

Dimensions of the SecurityReport.

EndTimestamp string

End timestamp of the query range.

Metrics List<string>

Metrics of the SecurityReport. Example: ["name:bot_count,func:sum,alias:sum_bot_count"]

MimeType string

MIME type / Output format.

StartTimestamp string

Start timestamp of the query range.

TimeUnit string

Query GroupBy time unit. Example: "seconds", "minute", "hour"

Dimensions []string

Dimensions of the SecurityReport.

EndTimestamp string

End timestamp of the query range.

Metrics []string

Metrics of the SecurityReport. Example: ["name:bot_count,func:sum,alias:sum_bot_count"]

MimeType string

MIME type / Output format.

StartTimestamp string

Start timestamp of the query range.

TimeUnit string

Query GroupBy time unit. Example: "seconds", "minute", "hour"

dimensions List<String>

Dimensions of the SecurityReport.

endTimestamp String

End timestamp of the query range.

metrics List<String>

Metrics of the SecurityReport. Example: ["name:bot_count,func:sum,alias:sum_bot_count"]

mimeType String

MIME type / Output format.

startTimestamp String

Start timestamp of the query range.

timeUnit String

Query GroupBy time unit. Example: "seconds", "minute", "hour"

dimensions string[]

Dimensions of the SecurityReport.

endTimestamp string

End timestamp of the query range.

metrics string[]

Metrics of the SecurityReport. Example: ["name:bot_count,func:sum,alias:sum_bot_count"]

mimeType string

MIME type / Output format.

startTimestamp string

Start timestamp of the query range.

timeUnit 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.

endTimestamp String

End timestamp of the query range.

metrics List<String>

Metrics of the SecurityReport. Example: ["name:bot_count,func:sum,alias:sum_bot_count"]

mimeType String

MIME type / Output format.

startTimestamp String

Start timestamp of the query range.

timeUnit String

Query GroupBy time unit. Example: "seconds", "minute", "hour"

GoogleCloudApigeeV1SecurityReportResultMetadataResponse

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
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0