com.google.monitoring.v3

Interface ListAlertPoliciesRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListAlertPoliciesRequest, ListAlertPoliciesRequest.Builder

public interface ListAlertPoliciesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getFilter() If provided, this field specifies the criteria that must be met by alert policies to be included in the response.
com.google.protobuf.ByteString	getFilterBytes() If provided, this field specifies the criteria that must be met by alert policies to be included in the response.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
String	getOrderBy() A comma-separated list of fields by which to sort the result.
com.google.protobuf.ByteString	getOrderByBytes() A comma-separated list of fields by which to sort the result.
int	getPageSize() The maximum number of results to return in a single response.
String	getPageToken() If this field is not empty then it must contain the `nextPageToken` value returned by a previous call to this method.
com.google.protobuf.ByteString	getPageTokenBytes() If this field is not empty then it must contain the `nextPageToken` value returned by a previous call to this method.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Required. The
 [project](https://cloud.google.com/monitoring/api/v3#project_name) whose
 alert policies are to be listed. The format is:

     projects/[PROJECT_ID_OR_NUMBER]

 Note that this field names the parent container in which the alerting
 policies to be listed are stored. To retrieve a single alerting policy
 by name, use the
 [GetAlertPolicy][google.monitoring.v3.AlertPolicyService.GetAlertPolicy]
 operation, instead.
 

string name = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Required. The
 [project](https://cloud.google.com/monitoring/api/v3#project_name) whose
 alert policies are to be listed. The format is:

     projects/[PROJECT_ID_OR_NUMBER]

 Note that this field names the parent container in which the alerting
 policies to be listed are stored. To retrieve a single alerting policy
 by name, use the
 [GetAlertPolicy][google.monitoring.v3.AlertPolicyService.GetAlertPolicy]
 operation, instead.
 

string name = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for name.

getFilter

String getFilter()

 If provided, this field specifies the criteria that must be met by
 alert policies to be included in the response.

 For more details, see [sorting and
 filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
 

string filter = 5;

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

 If provided, this field specifies the criteria that must be met by
 alert policies to be included in the response.

 For more details, see [sorting and
 filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
 

string filter = 5;

Returns:

The bytes for filter.

getOrderBy

String getOrderBy()

 A comma-separated list of fields by which to sort the result. Supports
 the same set of field references as the `filter` field. Entries can be
 prefixed with a minus sign to sort by the field in descending order.

 For more details, see [sorting and
 filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
 

string order_by = 6;

Returns:

The orderBy.

getOrderByBytes

com.google.protobuf.ByteString getOrderByBytes()

 A comma-separated list of fields by which to sort the result. Supports
 the same set of field references as the `filter` field. Entries can be
 prefixed with a minus sign to sort by the field in descending order.

 For more details, see [sorting and
 filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
 

string order_by = 6;

Returns:

The bytes for orderBy.

getPageSize

int getPageSize()

 The maximum number of results to return in a single response.
 

int32 page_size = 2;

Returns:

The pageSize.

getPageToken

String getPageToken()

 If this field is not empty then it must contain the `nextPageToken` value
 returned by a previous call to this method.  Using this field causes the
 method to return more results from the previous method call.
 

string page_token = 3;

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

 If this field is not empty then it must contain the `nextPageToken` value
 returned by a previous call to this method.  Using this field causes the
 method to return more results from the previous method call.
 

string page_token = 3;

Returns:

The bytes for pageToken.