Interface ListOrganizationImpactsRequestOrBuilder (0.16.0)

Version 0.16.0

• 0.20.0 (latest)
• 0.19.0
• 0.18.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public interface ListOrganizationImpactsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String 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.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

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.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for filter.

getPageSize()

public abstract int 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 than the requested page_size.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The pageSize.

getPageToken()

public abstract String 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.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

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.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for pageToken.

getParent()

public abstract String 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.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for parent.