Class ListGroupsRequest (3.56.0)

public final class ListGroupsRequest extends GeneratedMessageV3 implements ListGroupsRequestOrBuilder

The ListGroup request.

Protobuf type google.monitoring.v3.ListGroupsRequest

Static Fields

ANCESTORS_OF_GROUP_FIELD_NUMBER

public static final int ANCESTORS_OF_GROUP_FIELD_NUMBER
Field Value
Type Description
int

CHILDREN_OF_GROUP_FIELD_NUMBER

public static final int CHILDREN_OF_GROUP_FIELD_NUMBER
Field Value
Type Description
int

DESCENDANTS_OF_GROUP_FIELD_NUMBER

public static final int DESCENDANTS_OF_GROUP_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListGroupsRequest getDefaultInstance()
Returns
Type Description
ListGroupsRequest

getDescriptor()

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

newBuilder()

public static ListGroupsRequest.Builder newBuilder()
Returns
Type Description
ListGroupsRequest.Builder

newBuilder(ListGroupsRequest prototype)

public static ListGroupsRequest.Builder newBuilder(ListGroupsRequest prototype)
Parameter
Name Description
prototype ListGroupsRequest
Returns
Type Description
ListGroupsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListGroupsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListGroupsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListGroupsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListGroupsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListGroupsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListGroupsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListGroupsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListGroupsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListGroupsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListGroupsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListGroupsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListGroupsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListGroupsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListGroupsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListGroupsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListGroupsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListGroupsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListGroupsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListGroupsRequest> parser()
Returns
Type Description
Parser<ListGroupsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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.

getParserForType()

public Parser<ListGroupsRequest> getParserForType()
Returns
Type Description
Parser<ListGroupsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListGroupsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListGroupsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException