com.google.monitoring.v3

Interface ListNotificationChannelsRequestOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

ListNotificationChannelsRequest, ListNotificationChannelsRequest.Builder

public interface ListNotificationChannelsRequestOrBuilder
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 notification channels to be included in the response.
com.google.protobuf.ByteString	getFilterBytes() If provided, this field specifies the criteria that must be met by notification channels 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 non-empty, `page_token` must contain a value returned as the `next_page_token` in a previous response to request the next set of results.
com.google.protobuf.ByteString	getPageTokenBytes() If non-empty, `page_token` must contain a value returned as the `next_page_token` in a previous response to request the next set of results.

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) on which
 to execute the request. The format is:

     projects/[PROJECT_ID_OR_NUMBER]

 This names the container
 in which to look for the notification channels; it does not name a
 specific channel. To query a specific channel by REST resource name, use
 the
 [`GetNotificationChannel`][google.monitoring.v3.NotificationChannelService.GetNotificationChannel]
 operation.
 

string name = 5 [(.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) on which
 to execute the request. The format is:

     projects/[PROJECT_ID_OR_NUMBER]

 This names the container
 in which to look for the notification channels; it does not name a
 specific channel. To query a specific channel by REST resource name, use
 the
 [`GetNotificationChannel`][google.monitoring.v3.NotificationChannelService.GetNotificationChannel]
 operation.
 

string name = 5 [(.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
 notification channels 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 = 6;

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

 If provided, this field specifies the criteria that must be met by
 notification channels 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 = 6;

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 fields as in `filter`. Entries can be prefixed with
 a minus sign to sort in descending rather than ascending order.

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

string order_by = 7;

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 fields as in `filter`. Entries can be prefixed with
 a minus sign to sort in descending rather than ascending order.

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

string order_by = 7;

Returns:

The bytes for orderBy.

getPageSize

int getPageSize()

 The maximum number of results to return in a single response. If
 not set to a positive number, a reasonable value will be chosen by the
 service.
 

int32 page_size = 3;

Returns:

The pageSize.

getPageToken

String getPageToken()

 If non-empty, `page_token` must contain a value returned as the
 `next_page_token` in a previous response to request the next set
 of results.
 

string page_token = 4;

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

 If non-empty, `page_token` must contain a value returned as the
 `next_page_token` in a previous response to request the next set
 of results.
 

string page_token = 4;

Returns:

The bytes for pageToken.