Reference documentation and code samples for the Google Cloud Service Health V1 Client class ListOrganizationImpactsRequest.
Requests list of projects under an organization affected by an event.
Generated from protobuf message google.cloud.servicehealth.v1.ListOrganizationImpactsRequest
Namespace
Google \ Cloud \ ServiceHealth \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
โณ parent
string
Required. Parent value using the form organizations/{organization_id}/locations/{location}/organizationImpacts. organization_id - ID (number) of the project that contains the event. To get your organization_id, see Getting your organization resource ID.
โณ page_size
int
Optional. The maximum number of events that should be returned. Acceptable values are 1 to 100, inclusive. The default value is 10. If more results are available, the service returns a next_page_token that can be used to get the next page of results in subsequent list requests. The service may return fewer impacts than the requested page_size.
โณ page_token
string
Optional. A token identifying a page of results the server should return. Provide page_token returned by a previous ListOrganizationImpacts call to retrieve the next page of results. When paginating, all other parameters provided to ListOrganizationImpacts must match the call that provided the page token.
โณ filter
string
Optional. A filter expression that filters resources listed in the response. The expression is in the form of field:value for checking if a repeated field contains a value. Example: events:organizations%2F{organization_id}%2Flocations%2Fglobal%2ForganizationEvents%2Fevent-id To get your {organization_id}, see Getting your organization resource ID. Multiple filter queries are separated by spaces. By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. Filter is supported for the following fields: events.
getParent
Required. Parent value using the form
organizations/{organization_id}/locations/{location}/organizationImpacts.
Optional. The maximum number of events that should be returned. Acceptable
values are 1 to 100, inclusive. The default value is 10.
If more results are available, the service returns a
next_page_token that can be used to get the next page of results in
subsequent list requests. The service may return fewer
impacts
than the requested page_size.
Returns
Type
Description
int
setPageSize
Optional. The maximum number of events that should be returned. Acceptable
values are 1 to 100, inclusive. The default value is 10.
If more results are available, the service returns a
next_page_token that can be used to get the next page of results in
subsequent list requests. The service may return fewer
impacts
than the requested page_size.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. A token identifying a page of results the server should return.
Provide page_token returned by a previous ListOrganizationImpacts call
to retrieve the next page of results.
When paginating, all other parameters provided to ListOrganizationImpacts
must match the call that provided the page token.
Returns
Type
Description
string
setPageToken
Optional. A token identifying a page of results the server should return.
Provide page_token returned by a previous ListOrganizationImpacts call
to retrieve the next page of results.
When paginating, all other parameters provided to ListOrganizationImpacts
must match the call that provided the page token.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Optional. A filter expression that filters resources listed in the
response. The expression is in the form of field:value for checking if a
repeated field contains a value.
Example:
events:organizations%2F{organization_id}%2Flocations%2Fglobal%2ForganizationEvents%2Fevent-id
To get your {organization_id}, see
Getting your organization resource
ID.
Multiple filter queries are separated by spaces.
By default, each expression is an AND expression. However, you can include
AND and OR expressions explicitly.
Filter is supported for the following fields: events.
Returns
Type
Description
string
setFilter
Optional. A filter expression that filters resources listed in the
response. The expression is in the form of field:value for checking if a
repeated field contains a value.
Example:
events:organizations%2F{organization_id}%2Flocations%2Fglobal%2ForganizationEvents%2Fevent-id
To get your {organization_id}, see
Getting your organization resource
ID.
Multiple filter queries are separated by spaces.
By default, each expression is an AND expression. However, you can include
AND and OR expressions explicitly.
Filter is supported for the following fields: events.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. Parent value using the form
organizations/{organization_id}/locations/{location}/organizationImpacts.
organization_id - ID (number) of the project that contains the event. To
get your organization_id, see
Getting your organization resource
ID. Please see
ServiceHealthClient::organizationLocationName() for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Service Health V1 Client - Class ListOrganizationImpactsRequest (0.3.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.3.1 (latest)](/php/docs/reference/cloud-servicehealth/latest/V1.ListOrganizationImpactsRequest)\n- [0.3.0](/php/docs/reference/cloud-servicehealth/0.3.0/V1.ListOrganizationImpactsRequest)\n- [0.2.3](/php/docs/reference/cloud-servicehealth/0.2.3/V1.ListOrganizationImpactsRequest)\n- [0.1.8](/php/docs/reference/cloud-servicehealth/0.1.8/V1.ListOrganizationImpactsRequest) \nReference documentation and code samples for the Google Cloud Service Health V1 Client class ListOrganizationImpactsRequest.\n\nRequests list of projects under an organization affected by an event.\n\nGenerated from protobuf message `google.cloud.servicehealth.v1.ListOrganizationImpactsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ ServiceHealth \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. Parent value using the form\n`organizations/{organization_id}/locations/{location}/organizationImpacts`.\n\n`organization_id` - ID (number) of the project that contains the event. To\nget your `organization_id`, see\n[Getting your organization resource\nID](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id).\n\n### setParent\n\nRequired. Parent value using the form\n`organizations/{organization_id}/locations/{location}/organizationImpacts`.\n\n`organization_id` - ID (number) of the project that contains the event. To\nget your `organization_id`, see\n[Getting your organization resource\nID](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id).\n\n### getPageSize\n\nOptional. The maximum number of events that should be returned. Acceptable\nvalues are `1` to `100`, inclusive. The default value is `10`.\n\nIf more results are available, the service returns a\n`next_page_token` that can be used to get the next page of results in\nsubsequent list requests. The service may return fewer\n[impacts](/service-health/docs/reference/rest/v1beta/organizations.locations.organizationImpacts#OrganizationImpact)\nthan the requested `page_size`.\n\n### setPageSize\n\nOptional. The maximum number of events that should be returned. Acceptable\nvalues are `1` to `100`, inclusive. The default value is `10`.\n\nIf more results are available, the service returns a\n`next_page_token` that can be used to get the next page of results in\nsubsequent list requests. The service may return fewer\n[impacts](/service-health/docs/reference/rest/v1beta/organizations.locations.organizationImpacts#OrganizationImpact)\nthan the requested `page_size`.\n\n### getPageToken\n\nOptional. A token identifying a page of results the server should return.\n\nProvide `page_token` returned by a previous `ListOrganizationImpacts` call\nto retrieve the next page of results.\nWhen paginating, all other parameters provided to `ListOrganizationImpacts`\nmust match the call that provided the page token.\n\n### setPageToken\n\nOptional. A token identifying a page of results the server should return.\n\nProvide `page_token` returned by a previous `ListOrganizationImpacts` call\nto retrieve the next page of results.\nWhen paginating, all other parameters provided to `ListOrganizationImpacts`\nmust match the call that provided the page token.\n\n### getFilter\n\nOptional. A filter expression that filters resources listed in the\nresponse. The expression is in the form of `field:value` for checking if a\nrepeated field contains a value.\n\nExample:\n`events:organizations%2F{organization_id}%2Flocations%2Fglobal%2ForganizationEvents%2Fevent-id`\nTo get your `{organization_id}`, see\n[Getting your organization resource\nID](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id).\nMultiple filter queries are separated by spaces.\nBy default, each expression is an AND expression. However, you can include\nAND and OR expressions explicitly.\nFilter is supported for the following fields: `events`.\n\n### setFilter\n\nOptional. A filter expression that filters resources listed in the\nresponse. The expression is in the form of `field:value` for checking if a\nrepeated field contains a value.\n\nExample:\n`events:organizations%2F{organization_id}%2Flocations%2Fglobal%2ForganizationEvents%2Fevent-id`\nTo get your `{organization_id}`, see\n[Getting your organization resource\nID](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id).\nMultiple filter queries are separated by spaces.\nBy default, each expression is an AND expression. However, you can include\nAND and OR expressions explicitly.\nFilter is supported for the following fields: `events`.\n\n### static::build"]]
