# Google Cloud Service Health V1 Client - Class ListOrganizationImpactsRequest (0.5.0)

0.5.0 (latest) 0.4.3 0.3.1 0.2.3 0.1.8 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](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_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](https://docs.cloud.google.com/service-health/docs/reference/rest/v1beta/organizations.locations.organizationImpacts#OrganizationImpact) 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](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_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`.

`organization_id` - ID (number) of the project that contains the event. To
get your `organization_id`, see
[Getting your organization resource
ID](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setParent

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](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPageSize

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](https://docs.cloud.google.com/service-health/docs/reference/rest/v1beta/organizations.locations.organizationImpacts#OrganizationImpact)
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](https://docs.cloud.google.com/service-health/docs/reference/rest/v1beta/organizations.locations.organizationImpacts#OrganizationImpact)
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](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_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](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_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](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). Please see ServiceHealthClient::organizationLocationName() for help formatting this field. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-servicehealth/latest/V1.ListOrganizationImpactsRequest` |   |