Package com.google.monitoring.v3

Class ListGroupsRequest

  • All Implemented Interfaces:
    ListGroupsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ListGroupsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListGroupsRequestOrBuilder
     The `ListGroup` request.
    Protobuf type google.monitoring.v3.ListGroupsRequest
    See Also:
    Serialized Form

    • Field Detail

      • CHILDREN_OF_GROUP_FIELD_NUMBER

        public static final int CHILDREN_OF_GROUP_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ANCESTORS_OF_GROUP_FIELD_NUMBER

        public static final int ANCESTORS_OF_GROUP_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DESCENDANTS_OF_GROUP_FIELD_NUMBER

        public static final int DESCENDANTS_OF_GROUP_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PAGE_TOKEN_FIELD_NUMBER

        public static final int PAGE_TOKEN_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name)
 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) = { ... }
        Specified by:
        getName in interface ListGroupsRequestOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name)
 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) = { ... }
        Specified by:
        getNameBytes in interface ListGroupsRequestOrBuilder
        Returns:
        The bytes for name.

      • 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) = { ... }
        Specified by:
        hasChildrenOfGroup in interface ListGroupsRequestOrBuilder
        Returns:
        Whether the childrenOfGroup field is set.

      • 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) = { ... }
        Specified by:
        getChildrenOfGroup in interface ListGroupsRequestOrBuilder
        Returns:
        The childrenOfGroup.

      • getChildrenOfGroupBytes

        public com.google.protobuf.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) = { ... }
        Specified by:
        getChildrenOfGroupBytes in interface ListGroupsRequestOrBuilder
        Returns:
        The bytes for childrenOfGroup.

      • 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) = { ... }
        Specified by:
        hasAncestorsOfGroup in interface ListGroupsRequestOrBuilder
        Returns:
        Whether the ancestorsOfGroup field is set.

      • 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) = { ... }
        Specified by:
        getAncestorsOfGroup in interface ListGroupsRequestOrBuilder
        Returns:
        The ancestorsOfGroup.

      • getAncestorsOfGroupBytes

        public com.google.protobuf.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) = { ... }
        Specified by:
        getAncestorsOfGroupBytes in interface ListGroupsRequestOrBuilder
        Returns:
        The bytes for ancestorsOfGroup.

      • 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) = { ... }
        Specified by:
        hasDescendantsOfGroup in interface ListGroupsRequestOrBuilder
        Returns:
        Whether the descendantsOfGroup field is set.

      • 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) = { ... }
        Specified by:
        getDescendantsOfGroup in interface ListGroupsRequestOrBuilder
        Returns:
        The descendantsOfGroup.

      • getDescendantsOfGroupBytes

        public com.google.protobuf.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) = { ... }
        Specified by:
        getDescendantsOfGroupBytes in interface ListGroupsRequestOrBuilder
        Returns:
        The bytes for descendantsOfGroup.

      • getPageSize

        public int getPageSize()
         A positive number that is the maximum number of results to return.
        int32 page_size = 5;
        Specified by:
        getPageSize in interface ListGroupsRequestOrBuilder
        Returns:
        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;
        Specified by:
        getPageToken in interface ListGroupsRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.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;
        Specified by:
        getPageTokenBytes in interface ListGroupsRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ListGroupsRequest parseFrom​(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListGroupsRequest parseFrom​(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListGroupsRequest parseFrom​(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListGroupsRequest parseFrom​(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListGroupsRequest parseFrom​(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListGroupsRequest parseFrom​(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListGroupsRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Throws:
        IOException

      • newBuilderForType

        public ListGroupsRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ListGroupsRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ListGroupsRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ListGroupsRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ListGroupsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder