Console
    Contact Us Start free

    Stackdriver Monitoring V3 Client - Class ListGroupsRequest (1.6.0)

    Reference documentation and code samples for the Stackdriver Monitoring V3 Client class ListGroupsRequest.

    The ListGroup request.

    Generated from protobuf message google.monitoring.v3.ListGroupsRequest

    Namespace

    Google \ Cloud \ Monitoring \ V3

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

    Required. The project whose groups are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER]

    ↳ children_of_group
    string

    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.

    ↳ ancestors_of_group
    string

    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.

    ↳ descendants_of_group
    string

    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.

    ↳ page_size
    int

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

    ↳ page_token
    string

    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.

    getName

    Required. The project whose groups are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER]

    Returns
    Type
    Description
    string

    setName

    Required. The project whose groups are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER]

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    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.

    Returns
    Type
    Description
    string

    hasChildrenOfGroup

    setChildrenOfGroup

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    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.

    Returns
    Type
    Description
    string

    hasAncestorsOfGroup

    setAncestorsOfGroup

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    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.

    Returns
    Type
    Description
    string

    hasDescendantsOfGroup

    setDescendantsOfGroup

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getPageSize

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

    Returns
    Type
    Description
    int

    setPageSize

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

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    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.

    Returns
    Type
    Description
    string

    setPageToken

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getFilter

    Returns
    Type
    Description
    string

    static::build

    Parameter
    Name
    Description
    name
    string

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

    projects/[PROJECT_ID_OR_NUMBER]

    Returns
    Type
    Description
    Google\Cloud\Monitoring\V3\ListGroupsRequest
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: