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

Version latest

• 0.2.0 (latest)
• 0.1.0

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

The request message for ListFrameworkAudits.

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

Namespace

Google \ Cloud \ CloudSecurityCompliance \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The parent resource where the framework audits are listed. Supported formats are the following: * * organizations/{organization_id}/locations/{location} * * folders/{folder_id}/locations/{location} * * projects/{project_id}/locations/{location}
↳ page_size	int Optional. The maximum number of framework audits to return. The service might return fewer audits than this value. If unspecified, a maximum of 10 framework audits are returned. The maximum value is 50; values above 50 are limited to 50.
↳ page_token	string Optional. The next_page_token value that's returned from a previous list request, if any.
↳ filter	string Optional. The filters to apply to the framework audits. Supported filters are compliance_framework, compliance_state, create_time, and framework_audit_name. If the filter is invalid, an invalid argument error is returned. For syntax details, see [AIP-160][https://google.aip.dev/160].

getParent

Required. The parent resource where the framework audits are listed.

Supported formats are the following:

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

Returns
Type	Description
string

setParent

Required. The parent resource where the framework audits are listed.

Supported formats are the following:

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

Optional. The maximum number of framework audits to return. The service might return fewer audits than this value. If unspecified, a maximum of 10 framework audits are returned. The maximum value is 50; values above 50 are limited to 50.

Returns
Type	Description
int

setPageSize

Optional. The maximum number of framework audits to return. The service might return fewer audits than this value. If unspecified, a maximum of 10 framework audits are returned. The maximum value is 50; values above 50 are limited to 50.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

Optional. The next_page_token value that's returned from a previous list request, if any.

Returns
Type	Description
string

setPageToken

Optional. The next_page_token value that's returned from a previous list request, if any.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFilter

Optional. The filters to apply to the framework audits.

Supported filters are compliance_framework, compliance_state, create_time, and framework_audit_name. If the filter is invalid, an invalid argument error is returned. For syntax details, see [AIP-160][https://google.aip.dev/160].

Returns
Type	Description
string

setFilter

Optional. The filters to apply to the framework audits.

Supported filters are compliance_framework, compliance_state, create_time, and framework_audit_name. If the filter is invalid, an invalid argument error is returned. For syntax details, see [AIP-160][https://google.aip.dev/160].

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameter
Name	Description
parent	string Required. The parent resource where the framework audits are listed. Supported formats are the following: organizations/{organization_id}/locations/{location} folders/{folder_id}/locations/{location} projects/{project_id}/locations/{location} Please see AuditClient::organizationLocationName() for help formatting this field.

Returns
Type	Description
ListFrameworkAuditsRequest