Class ListAlertPoliciesRequest.Builder (3.84.0) 

public static final class ListAlertPoliciesRequest.Builder extends GeneratedMessage.Builder<ListAlertPoliciesRequest.Builder> implements ListAlertPoliciesRequestOrBuilder

The protocol for the ListAlertPolicies request.

Protobuf type google.monitoring.v3.ListAlertPoliciesRequest

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ListAlertPoliciesRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public ListAlertPoliciesRequest build()
Returns
Type Description
ListAlertPoliciesRequest

buildPartial()

public ListAlertPoliciesRequest buildPartial()
Returns
Type Description
ListAlertPoliciesRequest

clear()

public ListAlertPoliciesRequest.Builder clear()
Returns
Type Description
ListAlertPoliciesRequest.Builder
Overrides

clearFilter()

public ListAlertPoliciesRequest.Builder clearFilter()

Optional. 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.

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

Returns
Type Description
ListAlertPoliciesRequest.Builder

This builder for chaining.

clearName()

public ListAlertPoliciesRequest.Builder clearName()

Required. The project 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 operation, instead.

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

Returns
Type Description
ListAlertPoliciesRequest.Builder

This builder for chaining.

clearOrderBy()

public ListAlertPoliciesRequest.Builder clearOrderBy()

Optional. 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.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListAlertPoliciesRequest.Builder

This builder for chaining.

clearPageSize()

public ListAlertPoliciesRequest.Builder clearPageSize()

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

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

Returns
Type Description
ListAlertPoliciesRequest.Builder

This builder for chaining.

clearPageToken()

public ListAlertPoliciesRequest.Builder clearPageToken()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListAlertPoliciesRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListAlertPoliciesRequest getDefaultInstanceForType()
Returns
Type Description
ListAlertPoliciesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

public String getFilter()

Optional. 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.

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. 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.

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

Returns
Type Description
ByteString

The bytes for filter.

getName()

public String getName()

Required. The project 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 operation, instead.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The project 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 operation, instead.

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

Returns
Type Description
ByteString

The bytes for name.

getOrderBy()

public String getOrderBy()

Optional. 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.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. 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.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

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

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListAlertPoliciesRequest other)

public ListAlertPoliciesRequest.Builder mergeFrom(ListAlertPoliciesRequest other)
Parameter
Name Description
other ListAlertPoliciesRequest
Returns
Type Description
ListAlertPoliciesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListAlertPoliciesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListAlertPoliciesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListAlertPoliciesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListAlertPoliciesRequest.Builder
Overrides

setFilter(String value)

public ListAlertPoliciesRequest.Builder setFilter(String value)

Optional. 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.

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

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
ListAlertPoliciesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListAlertPoliciesRequest.Builder setFilterBytes(ByteString value)

Optional. 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.

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

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
ListAlertPoliciesRequest.Builder

This builder for chaining.

setName(String value)

public ListAlertPoliciesRequest.Builder setName(String value)

Required. The project 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 operation, instead.

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
ListAlertPoliciesRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ListAlertPoliciesRequest.Builder setNameBytes(ByteString value)

Required. The project 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 operation, instead.

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
ListAlertPoliciesRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListAlertPoliciesRequest.Builder setOrderBy(String value)

Optional. 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.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The orderBy to set.
Returns
Type Description
ListAlertPoliciesRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListAlertPoliciesRequest.Builder setOrderByBytes(ByteString value)

Optional. 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.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for orderBy to set.
Returns
Type Description
ListAlertPoliciesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListAlertPoliciesRequest.Builder setPageSize(int value)

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

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

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
ListAlertPoliciesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListAlertPoliciesRequest.Builder setPageToken(String value)

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
ListAlertPoliciesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListAlertPoliciesRequest.Builder setPageTokenBytes(ByteString value)

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
ListAlertPoliciesRequest.Builder

This builder for chaining.