Google Cloud Security Compliance V1 Client - Class GenerateFrameworkAuditScopeReportRequest (0.2.0)

Reference documentation and code samples for the Google Cloud Security Compliance V1 Client class GenerateFrameworkAuditScopeReportRequest.

The request message for GenerateFrameworkAuditScopeReport.

Generated from protobuf message google.cloud.cloudsecuritycompliance.v1.GenerateFrameworkAuditScopeReportRequest

Namespace

Google \ Cloud \ CloudSecurityCompliance \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ scope string

Required. The organization, folder or project for the audit report. Supported formats are the following: * * projects/{project_id}/locations/{location} * * folders/{folder_id}/locations/{location} * * organizations/{organization_id}/locations/{location}
↳ report_format int

Required. The format that the scope report bytes is returned in.
↳ compliance_framework string

Required. The compliance framework that the scope report is generated for.

getScope

Required. The organization, folder or project for the audit report.

Supported formats are the following:

  • projects/{project_id}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • organizations/{organization_id}/locations/{location}
Returns
Type Description
string

setScope

Required. The organization, folder or project for the audit report.

Supported formats are the following:

  • projects/{project_id}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • organizations/{organization_id}/locations/{location}
Parameter
Name Description
var string
Returns
Type Description
$this

getReportFormat

Required. The format that the scope report bytes is returned in.

Returns
Type Description
int Enum of type Format.

setReportFormat

Required. The format that the scope report bytes is returned in.

Parameter
Name Description
var int

Enum of type Format.

Returns
Type Description
$this

getComplianceFramework

Required. The compliance framework that the scope report is generated for.

Returns
Type Description
string

setComplianceFramework

Required. The compliance framework that the scope report is generated for.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
scope string

Required. The organization, folder or project for the audit report.

Supported formats are the following:

    • projects/{project_id}/locations/{location}
    • folders/{folder_id}/locations/{location}
    • organizations/{organization_id}/locations/{location}
reportFormat int

Required. The format that the scope report bytes is returned in. For allowed values, use constants defined on GenerateFrameworkAuditScopeReportRequest\Format
complianceFramework string

Required. The compliance framework that the scope report is generated for.
Returns
Type Description
GenerateFrameworkAuditScopeReportRequest