Monitoring.Projects.Groups.List (Stackdriver Monitoring API v3 (Rev. 471) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.monitoring.v3.MonitoringRequest<ListGroupsResponse>
        
        com.google.api.services.monitoring.v3.Monitoring.Projects.Groups.List

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Monitoring.Projects.Groups
```
public class Monitoring.Projects.Groups.List
extends MonitoringRequest<ListGroupsResponse>
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected List(java.lang.String name)
Lists the existing groups.

Constructors
Modifier	Constructor and Description
`protected`	`List(java.lang.String name)` Lists the existing groups.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`java.lang.String`	`getAncestorsOfGroup()` A group name: "projects/{project_id_or_number}/groups/{group_id}".
`java.lang.String`	`getChildrenOfGroup()` A group name: "projects/{project_id_or_number}/groups/{group_id}".
`java.lang.String`	`getDescendantsOfGroup()` A group name: "projects/{project_id_or_number}/groups/{group_id}".
`java.lang.String`	`getName()` The project whose groups are to be listed.
`java.lang.Integer`	`getPageSize()` A positive number that is the maximum number of results to return.
`java.lang.String`	`getPageToken()` If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method.
`Monitoring.Projects.Groups.List`	`set(java.lang.String parameterName, java.lang.Object value)`
`Monitoring.Projects.Groups.List`	`set$Xgafv(java.lang.String $Xgafv)` V1 error format.
`Monitoring.Projects.Groups.List`	`setAccessToken(java.lang.String accessToken)` OAuth access token.
`Monitoring.Projects.Groups.List`	`setAlt(java.lang.String alt)` Data format for response.
`Monitoring.Projects.Groups.List`	`setAncestorsOfGroup(java.lang.String ancestorsOfGroup)` A group name: "projects/{project_id_or_number}/groups/{group_id}".
`Monitoring.Projects.Groups.List`	`setCallback(java.lang.String callback)` JSONP
`Monitoring.Projects.Groups.List`	`setChildrenOfGroup(java.lang.String childrenOfGroup)` A group name: "projects/{project_id_or_number}/groups/{group_id}".
`Monitoring.Projects.Groups.List`	`setDescendantsOfGroup(java.lang.String descendantsOfGroup)` A group name: "projects/{project_id_or_number}/groups/{group_id}".
`Monitoring.Projects.Groups.List`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Monitoring.Projects.Groups.List`	`setKey(java.lang.String key)` API key.
`Monitoring.Projects.Groups.List`	`setName(java.lang.String name)` The project whose groups are to be listed.
`Monitoring.Projects.Groups.List`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Monitoring.Projects.Groups.List`	`setPageSize(java.lang.Integer pageSize)` A positive number that is the maximum number of results to return.
`Monitoring.Projects.Groups.List`	`setPageToken(java.lang.String pageToken)` If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method.
`Monitoring.Projects.Groups.List`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Monitoring.Projects.Groups.List`	`setQuotaUser(java.lang.String quotaUser)` Available to use for quota purposes for server-side applications.
`Monitoring.Projects.Groups.List`	`setUploadProtocol(java.lang.String uploadProtocol)` Upload protocol for media (e.g.
`Monitoring.Projects.Groups.List`	`setUploadType(java.lang.String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.monitoring.v3.MonitoringRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - List
```
protected List(java.lang.String name)
```
    Lists the existing groups. Create a request for the method "groups.list". This request holds the parameters needed by the the monitoring server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Monitoring.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    name - The project whose groups are to be listed. The format is "projects/{project_id_or_number}".
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListGroupsResponse>
    
    Throws:
    
    java.io.IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListGroupsResponse>
    
    Throws:
    
    java.io.IOException
  - set$Xgafv
```
public Monitoring.Projects.Groups.List set$Xgafv(java.lang.String $Xgafv)
```
    Description copied from class: MonitoringRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class MonitoringRequest<ListGroupsResponse>
  - setAccessToken
```
public Monitoring.Projects.Groups.List setAccessToken(java.lang.String accessToken)
```
    Description copied from class: MonitoringRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class MonitoringRequest<ListGroupsResponse>
  - setAlt
```
public Monitoring.Projects.Groups.List setAlt(java.lang.String alt)
```
    Description copied from class: MonitoringRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class MonitoringRequest<ListGroupsResponse>
  - setCallback
```
public Monitoring.Projects.Groups.List setCallback(java.lang.String callback)
```
    Description copied from class: MonitoringRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class MonitoringRequest<ListGroupsResponse>
  - setFields
```
public Monitoring.Projects.Groups.List setFields(java.lang.String fields)
```
    Description copied from class: MonitoringRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class MonitoringRequest<ListGroupsResponse>
  - setKey
```
public Monitoring.Projects.Groups.List setKey(java.lang.String key)
```
    Description copied from class: MonitoringRequest
    
    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    
    Overrides:
    
    setKey in class MonitoringRequest<ListGroupsResponse>
  - setOauthToken
```
public Monitoring.Projects.Groups.List setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: MonitoringRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class MonitoringRequest<ListGroupsResponse>
  - setPrettyPrint
```
public Monitoring.Projects.Groups.List setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: MonitoringRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class MonitoringRequest<ListGroupsResponse>
  - setQuotaUser
```
public Monitoring.Projects.Groups.List setQuotaUser(java.lang.String quotaUser)
```
    Description copied from class: MonitoringRequest
    
    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class MonitoringRequest<ListGroupsResponse>
  - setUploadType
```
public Monitoring.Projects.Groups.List setUploadType(java.lang.String uploadType)
```
    Description copied from class: MonitoringRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class MonitoringRequest<ListGroupsResponse>
  - setUploadProtocol
```
public Monitoring.Projects.Groups.List setUploadProtocol(java.lang.String uploadProtocol)
```
    Description copied from class: MonitoringRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class MonitoringRequest<ListGroupsResponse>
  - getName
```
public java.lang.String getName()
```
    The project whose groups are to be listed. The format is "projects/{project_id_or_number}".
  - setName
```
public Monitoring.Projects.Groups.List setName(java.lang.String name)
```
    The project whose groups are to be listed. The format is "projects/{project_id_or_number}".
  - getChildrenOfGroup
```
public java.lang.String getChildrenOfGroup()
```
    A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty.
  - setChildrenOfGroup
```
public Monitoring.Projects.Groups.List setChildrenOfGroup(java.lang.String childrenOfGroup)
```
    A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty.
  - getDescendantsOfGroup
```
public java.lang.String getDescendantsOfGroup()
```
    A group name: "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 childrenOfGroup filter, and includes children-of-children, and so forth.
  - setDescendantsOfGroup
```
public Monitoring.Projects.Groups.List setDescendantsOfGroup(java.lang.String descendantsOfGroup)
```
    A group name: "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 childrenOfGroup filter, and includes children-of-children, and so forth.
  - getPageToken
```
public java.lang.String getPageToken()
```
    If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
  - setPageToken
```
public Monitoring.Projects.Groups.List setPageToken(java.lang.String pageToken)
```
    If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
  - getPageSize
```
public java.lang.Integer getPageSize()
```
    A positive number that is the maximum number of results to return.
  - setPageSize
```
public Monitoring.Projects.Groups.List setPageSize(java.lang.Integer pageSize)
```
    A positive number that is the maximum number of results to return.
  - getAncestorsOfGroup
```
public java.lang.String getAncestorsOfGroup()
```
    A group name: "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.
  - setAncestorsOfGroup
```
public Monitoring.Projects.Groups.List setAncestorsOfGroup(java.lang.String ancestorsOfGroup)
```
    A group name: "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.
  - set
```
public Monitoring.Projects.Groups.List set(java.lang.String parameterName,
                                           java.lang.Object value)
```
    Overrides:
    
    set in class MonitoringRequest<ListGroupsResponse>

Stackdriver Monitoring API v3 (revision 471)

Class Monitoring.Projects.Groups.List

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.monitoring.v3.MonitoringRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getName

setName

getChildrenOfGroup

setChildrenOfGroup

getDescendantsOfGroup

setDescendantsOfGroup

getPageToken

setPageToken

getPageSize

setPageSize

getAncestorsOfGroup

setAncestorsOfGroup

set