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
CHILDREN_OF_GROUP_FIELD_NUMBER
public static final int CHILDREN_OF_GROUP_FIELD_NUMBER
Field Value
DESCENDANTS_OF_GROUP_FIELD_NUMBER
public static final int DESCENDANTS_OF_GROUP_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ListGroupsRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ListGroupsRequest.Builder newBuilder()
Returns
newBuilder(ListGroupsRequest prototype)
public static ListGroupsRequest.Builder newBuilder(ListGroupsRequest prototype)
Parameter
Returns
public static ListGroupsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListGroupsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ListGroupsRequest parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListGroupsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ListGroupsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListGroupsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListGroupsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListGroupsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListGroupsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListGroupsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ListGroupsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListGroupsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ListGroupsRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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
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
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
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
getParserForType()
public Parser<ListGroupsRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ListGroupsRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListGroupsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ListGroupsRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions