Class ListGroupsRequest.Builder (3.55.0) 

public static final class ListGroupsRequest.Builder extends GeneratedMessageV3.Builder<ListGroupsRequest.Builder> implements ListGroupsRequestOrBuilder

The ListGroup request.

Protobuf type google.monitoring.v3.ListGroupsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListGroupsRequest.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListGroupsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListGroupsRequest.Builder
Overrides

build()

public ListGroupsRequest build()
Returns
Type Description
ListGroupsRequest

buildPartial()

public ListGroupsRequest buildPartial()
Returns
Type Description
ListGroupsRequest

clear()

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

clearAncestorsOfGroup()

public ListGroupsRequest.Builder clearAncestorsOfGroup()

A group name. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.

string ancestors_of_group = 3 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ListGroupsRequest.Builder

This builder for chaining.

clearChildrenOfGroup()

public ListGroupsRequest.Builder clearChildrenOfGroup()

A group name. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns groups whose parent_name field contains the group name. If no groups have this parent, the results are empty.

string children_of_group = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ListGroupsRequest.Builder

This builder for chaining.

clearDescendantsOfGroup()

public ListGroupsRequest.Builder clearDescendantsOfGroup()

A group name. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns the descendants of the specified group. This is a superset of the results returned by the children_of_group filter, and includes children-of-children, and so forth.

string descendants_of_group = 4 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ListGroupsRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ListGroupsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListGroupsRequest.Builder
Overrides

clearFilter()

public ListGroupsRequest.Builder clearFilter()
Returns
Type Description
ListGroupsRequest.Builder

clearName()

public ListGroupsRequest.Builder clearName()

Required. The project whose groups are to be listed. The format is:

 projects/[PROJECT_ID_OR_NUMBER]

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

Returns
Type Description
ListGroupsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListGroupsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListGroupsRequest.Builder
Overrides

clearPageSize()

public ListGroupsRequest.Builder clearPageSize()

A positive number that is the maximum number of results to return.

int32 page_size = 5;

Returns
Type Description
ListGroupsRequest.Builder

This builder for chaining.

clearPageToken()

public ListGroupsRequest.Builder clearPageToken()

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

string page_token = 6;

Returns
Type Description
ListGroupsRequest.Builder

This builder for chaining.

clone()

public ListGroupsRequest.Builder clone()
Returns
Type Description
ListGroupsRequest.Builder
Overrides

getAncestorsOfGroup()

public String getAncestorsOfGroup()

A group name. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.

string ancestors_of_group = 3 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The ancestorsOfGroup.

getAncestorsOfGroupBytes()

public ByteString getAncestorsOfGroupBytes()

A group name. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.

string ancestors_of_group = 3 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for ancestorsOfGroup.

getChildrenOfGroup()

public String getChildrenOfGroup()

A group name. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns groups whose parent_name field contains the group name. If no groups have this parent, the results are empty.

string children_of_group = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The childrenOfGroup.

getChildrenOfGroupBytes()

public ByteString getChildrenOfGroupBytes()

A group name. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns groups whose parent_name field contains the group name. If no groups have this parent, the results are empty.

string children_of_group = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for childrenOfGroup.

getDefaultInstanceForType()

public ListGroupsRequest getDefaultInstanceForType()
Returns
Type Description
ListGroupsRequest

getDescendantsOfGroup()

public String getDescendantsOfGroup()

A group name. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns the descendants of the specified group. This is a superset of the results returned by the children_of_group filter, and includes children-of-children, and so forth.

string descendants_of_group = 4 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The descendantsOfGroup.

getDescendantsOfGroupBytes()

public ByteString getDescendantsOfGroupBytes()

A group name. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns the descendants of the specified group. This is a superset of the results returned by the children_of_group filter, and includes children-of-children, and so forth.

string descendants_of_group = 4 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for descendantsOfGroup.

getDescriptorForType()

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

getFilterCase()

public ListGroupsRequest.FilterCase getFilterCase()
Returns
Type Description
ListGroupsRequest.FilterCase

getName()

public String getName()

Required. The project whose groups are to be listed. The format is:

 projects/[PROJECT_ID_OR_NUMBER]

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The project whose groups are to be listed. The format is:

 projects/[PROJECT_ID_OR_NUMBER]

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

Returns
Type Description
ByteString

The bytes for name.

getPageSize()

public int getPageSize()

A positive number that is the maximum number of results to return.

int32 page_size = 5;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

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

string page_token = 6;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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

string page_token = 6;

Returns
Type Description
ByteString

The bytes for pageToken.

hasAncestorsOfGroup()

public boolean hasAncestorsOfGroup()

A group name. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.

string ancestors_of_group = 3 [(.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the ancestorsOfGroup field is set.

hasChildrenOfGroup()

public boolean hasChildrenOfGroup()

A group name. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns groups whose parent_name field contains the group name. If no groups have this parent, the results are empty.

string children_of_group = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the childrenOfGroup field is set.

hasDescendantsOfGroup()

public boolean hasDescendantsOfGroup()

A group name. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns the descendants of the specified group. This is a superset of the results returned by the children_of_group filter, and includes children-of-children, and so forth.

string descendants_of_group = 4 [(.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the descendantsOfGroup field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListGroupsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListGroupsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListGroupsRequest.Builder
Overrides

setAncestorsOfGroup(String value)

public ListGroupsRequest.Builder setAncestorsOfGroup(String value)

A group name. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.

string ancestors_of_group = 3 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The ancestorsOfGroup to set.
Returns
Type Description
ListGroupsRequest.Builder

This builder for chaining.

setAncestorsOfGroupBytes(ByteString value)

public ListGroupsRequest.Builder setAncestorsOfGroupBytes(ByteString value)

A group name. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.

string ancestors_of_group = 3 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for ancestorsOfGroup to set.
Returns
Type Description
ListGroupsRequest.Builder

This builder for chaining.

setChildrenOfGroup(String value)

public ListGroupsRequest.Builder setChildrenOfGroup(String value)

A group name. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns groups whose parent_name field contains the group name. If no groups have this parent, the results are empty.

string children_of_group = 2 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The childrenOfGroup to set.
Returns
Type Description
ListGroupsRequest.Builder

This builder for chaining.

setChildrenOfGroupBytes(ByteString value)

public ListGroupsRequest.Builder setChildrenOfGroupBytes(ByteString value)

A group name. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns groups whose parent_name field contains the group name. If no groups have this parent, the results are empty.

string children_of_group = 2 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for childrenOfGroup to set.
Returns
Type Description
ListGroupsRequest.Builder

This builder for chaining.

setDescendantsOfGroup(String value)

public ListGroupsRequest.Builder setDescendantsOfGroup(String value)

A group name. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns the descendants of the specified group. This is a superset of the results returned by the children_of_group filter, and includes children-of-children, and so forth.

string descendants_of_group = 4 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The descendantsOfGroup to set.
Returns
Type Description
ListGroupsRequest.Builder

This builder for chaining.

setDescendantsOfGroupBytes(ByteString value)

public ListGroupsRequest.Builder setDescendantsOfGroupBytes(ByteString value)

A group name. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns the descendants of the specified group. This is a superset of the results returned by the children_of_group filter, and includes children-of-children, and so forth.

string descendants_of_group = 4 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for descendantsOfGroup to set.
Returns
Type Description
ListGroupsRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ListGroupsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListGroupsRequest.Builder
Overrides

setName(String value)

public ListGroupsRequest.Builder setName(String value)

Required. The project whose groups are to be listed. The format is:

 projects/[PROJECT_ID_OR_NUMBER]

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
ListGroupsRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ListGroupsRequest.Builder setNameBytes(ByteString value)

Required. The project whose groups are to be listed. The format is:

 projects/[PROJECT_ID_OR_NUMBER]

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

Parameter
Name Description
value ByteString

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

This builder for chaining.

setPageSize(int value)

public ListGroupsRequest.Builder setPageSize(int value)

A positive number that is the maximum number of results to return.

int32 page_size = 5;

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
ListGroupsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListGroupsRequest.Builder setPageToken(String value)

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

string page_token = 6;

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
ListGroupsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListGroupsRequest.Builder setPageTokenBytes(ByteString value)

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

string page_token = 6;

Parameter
Name Description
value ByteString

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

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListGroupsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListGroupsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListGroupsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListGroupsRequest.Builder
Overrides