Google Cloud Monitoring v3 API - Class ListGroupsRequest (3.12.0)

public sealed class ListGroupsRequest : IMessage<ListGroupsRequest>, IEquatable<ListGroupsRequest>, IDeepCloneable<ListGroupsRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Google Cloud Monitoring v3 API class ListGroupsRequest.

The ListGroup request.

Inheritance

object > ListGroupsRequest

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

ListGroupsRequest()

public ListGroupsRequest()

ListGroupsRequest(ListGroupsRequest)

public ListGroupsRequest(ListGroupsRequest other)
Parameter
Name Description
other ListGroupsRequest

Properties

AncestorsOfGroup

public string AncestorsOfGroup { get; set; }

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.

Property Value
Type Description
string

AncestorsOfGroupAsGroupName

public GroupName AncestorsOfGroupAsGroupName { get; set; }

GroupName-typed view over the AncestorsOfGroup resource name property.

Property Value
Type Description
GroupName

AncestorsOfGroupAsResourceName

public IResourceName AncestorsOfGroupAsResourceName { get; set; }

IResourceName-typed view over the AncestorsOfGroup resource name property.

Property Value
Type Description
IResourceName

ChildrenOfGroup

public string ChildrenOfGroup { get; set; }

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.

Property Value
Type Description
string

ChildrenOfGroupAsGroupName

public GroupName ChildrenOfGroupAsGroupName { get; set; }

GroupName-typed view over the ChildrenOfGroup resource name property.

Property Value
Type Description
GroupName

ChildrenOfGroupAsResourceName

public IResourceName ChildrenOfGroupAsResourceName { get; set; }

IResourceName-typed view over the ChildrenOfGroup resource name property.

Property Value
Type Description
IResourceName

DescendantsOfGroup

public string DescendantsOfGroup { get; set; }

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.

Property Value
Type Description
string

DescendantsOfGroupAsGroupName

public GroupName DescendantsOfGroupAsGroupName { get; set; }

GroupName-typed view over the DescendantsOfGroup resource name property.

Property Value
Type Description
GroupName

DescendantsOfGroupAsResourceName

public IResourceName DescendantsOfGroupAsResourceName { get; set; }

IResourceName-typed view over the DescendantsOfGroup resource name property.

Property Value
Type Description
IResourceName

FilterCase

public ListGroupsRequest.FilterOneofCase FilterCase { get; }
Property Value
Type Description
ListGroupsRequestFilterOneofCase

FolderName

public FolderName FolderName { get; set; }

FolderName-typed view over the Name resource name property.

Property Value
Type Description
FolderName

HasAncestorsOfGroup

public bool HasAncestorsOfGroup { get; }

Gets whether the "ancestors_of_group" field is set

Property Value
Type Description
bool

HasChildrenOfGroup

public bool HasChildrenOfGroup { get; }

Gets whether the "children_of_group" field is set

Property Value
Type Description
bool

HasDescendantsOfGroup

public bool HasDescendantsOfGroup { get; }

Gets whether the "descendants_of_group" field is set

Property Value
Type Description
bool

Name

public string Name { get; set; }

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

projects/[PROJECT_ID_OR_NUMBER]
Property Value
Type Description
string

OrganizationName

public OrganizationName OrganizationName { get; set; }

OrganizationName-typed view over the Name resource name property.

Property Value
Type Description
OrganizationName

PageSize

public int PageSize { get; set; }

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

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

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.

Property Value
Type Description
string

ProjectName

public ProjectName ProjectName { get; set; }

ProjectName-typed view over the Name resource name property.

Property Value
Type Description
ProjectName

ResourceName

public IResourceName ResourceName { get; set; }

IResourceName-typed view over the Name resource name property.

Property Value
Type Description
IResourceName