CloudFilestore.Projects.Locations.Instances.List (Cloud Filestore API v1 (Rev. 22) 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.file.v1.CloudFilestoreRequest<ListInstancesResponse>
        
        com.google.api.services.file.v1.CloudFilestore.Projects.Locations.Instances.List

All Implemented Interfaces:

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

Enclosing class:

CloudFilestore.Projects.Locations.Instances
```
public class CloudFilestore.Projects.Locations.Instances.List
extends CloudFilestoreRequest<ListInstancesResponse>
```

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 parent)
Lists all instances in a project for either a specified location or for all locations.

Constructors
Modifier	Constructor and Description
`protected`	`List(java.lang.String parent)` Lists all instances in a project for either a specified location or for all locations.

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`	`getFilter()` List filter.
`java.lang.String`	`getOrderBy()` Sort results.
`java.lang.Integer`	`getPageSize()` The maximum number of items to return.
`java.lang.String`	`getPageToken()` The next_page_token value to use if there are additional results to retrieve for this list request.
`java.lang.String`	`getParent()` The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}.
`CloudFilestore.Projects.Locations.Instances.List`	`set(java.lang.String parameterName, java.lang.Object value)`
`CloudFilestore.Projects.Locations.Instances.List`	`set$Xgafv(java.lang.String $Xgafv)` V1 error format.
`CloudFilestore.Projects.Locations.Instances.List`	`setAccessToken(java.lang.String accessToken)` OAuth access token.
`CloudFilestore.Projects.Locations.Instances.List`	`setAlt(java.lang.String alt)` Data format for response.
`CloudFilestore.Projects.Locations.Instances.List`	`setCallback(java.lang.String callback)` JSONP
`CloudFilestore.Projects.Locations.Instances.List`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`CloudFilestore.Projects.Locations.Instances.List`	`setFilter(java.lang.String filter)` List filter.
`CloudFilestore.Projects.Locations.Instances.List`	`setKey(java.lang.String key)` API key.
`CloudFilestore.Projects.Locations.Instances.List`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`CloudFilestore.Projects.Locations.Instances.List`	`setOrderBy(java.lang.String orderBy)` Sort results.
`CloudFilestore.Projects.Locations.Instances.List`	`setPageSize(java.lang.Integer pageSize)` The maximum number of items to return.
`CloudFilestore.Projects.Locations.Instances.List`	`setPageToken(java.lang.String pageToken)` The next_page_token value to use if there are additional results to retrieve for this list request.
`CloudFilestore.Projects.Locations.Instances.List`	`setParent(java.lang.String parent)` The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}.
`CloudFilestore.Projects.Locations.Instances.List`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`CloudFilestore.Projects.Locations.Instances.List`	`setQuotaUser(java.lang.String quotaUser)` Available to use for quota purposes for server-side applications.
`CloudFilestore.Projects.Locations.Instances.List`	`setUploadProtocol(java.lang.String uploadProtocol)` Upload protocol for media (e.g.
`CloudFilestore.Projects.Locations.Instances.List`	`setUploadType(java.lang.String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.file.v1.CloudFilestoreRequest
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 parent)
```
    Lists all instances in a project for either a specified location or for all locations. Create a request for the method "instances.list". This request holds the parameters needed by the the file server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    CloudFilestore.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    parent - The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. To retrieve instance information for all locations, use "-" for the {location} value.
    
    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<ListInstancesResponse>
    
    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<ListInstancesResponse>
    
    Throws:
    
    java.io.IOException
  - set$Xgafv
```
public CloudFilestore.Projects.Locations.Instances.List set$Xgafv(java.lang.String $Xgafv)
```
    Description copied from class: CloudFilestoreRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class CloudFilestoreRequest<ListInstancesResponse>
  - setAccessToken
```
public CloudFilestore.Projects.Locations.Instances.List setAccessToken(java.lang.String accessToken)
```
    Description copied from class: CloudFilestoreRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class CloudFilestoreRequest<ListInstancesResponse>
  - setAlt
```
public CloudFilestore.Projects.Locations.Instances.List setAlt(java.lang.String alt)
```
    Description copied from class: CloudFilestoreRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class CloudFilestoreRequest<ListInstancesResponse>
  - setCallback
```
public CloudFilestore.Projects.Locations.Instances.List setCallback(java.lang.String callback)
```
    Description copied from class: CloudFilestoreRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class CloudFilestoreRequest<ListInstancesResponse>
  - setFields
```
public CloudFilestore.Projects.Locations.Instances.List setFields(java.lang.String fields)
```
    Description copied from class: CloudFilestoreRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class CloudFilestoreRequest<ListInstancesResponse>
  - setKey
```
public CloudFilestore.Projects.Locations.Instances.List setKey(java.lang.String key)
```
    Description copied from class: CloudFilestoreRequest
    
    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 CloudFilestoreRequest<ListInstancesResponse>
  - setOauthToken
```
public CloudFilestore.Projects.Locations.Instances.List setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: CloudFilestoreRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class CloudFilestoreRequest<ListInstancesResponse>
  - setPrettyPrint
```
public CloudFilestore.Projects.Locations.Instances.List setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: CloudFilestoreRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class CloudFilestoreRequest<ListInstancesResponse>
  - setQuotaUser
```
public CloudFilestore.Projects.Locations.Instances.List setQuotaUser(java.lang.String quotaUser)
```
    Description copied from class: CloudFilestoreRequest
    
    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 CloudFilestoreRequest<ListInstancesResponse>
  - setUploadType
```
public CloudFilestore.Projects.Locations.Instances.List setUploadType(java.lang.String uploadType)
```
    Description copied from class: CloudFilestoreRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class CloudFilestoreRequest<ListInstancesResponse>
  - setUploadProtocol
```
public CloudFilestore.Projects.Locations.Instances.List setUploadProtocol(java.lang.String uploadProtocol)
```
    Description copied from class: CloudFilestoreRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class CloudFilestoreRequest<ListInstancesResponse>
  - getParent
```
public java.lang.String getParent()
```
    The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. To retrieve instance information for all locations, use "-" for the {location} value.
  - setParent
```
public CloudFilestore.Projects.Locations.Instances.List setParent(java.lang.String parent)
```
    The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. To retrieve instance information for all locations, use "-" for the {location} value.
  - getFilter
```
public java.lang.String getFilter()
```
    List filter.
  - setFilter
```
public CloudFilestore.Projects.Locations.Instances.List setFilter(java.lang.String filter)
```
    List filter.
  - getPageToken
```
public java.lang.String getPageToken()
```
    The next_page_token value to use if there are additional results to retrieve for this list request.
  - setPageToken
```
public CloudFilestore.Projects.Locations.Instances.List setPageToken(java.lang.String pageToken)
```
    The next_page_token value to use if there are additional results to retrieve for this list request.
  - getOrderBy
```
public java.lang.String getOrderBy()
```
    Sort results. Supported values are "name", "name desc" or "" (unsorted).
  - setOrderBy
```
public CloudFilestore.Projects.Locations.Instances.List setOrderBy(java.lang.String orderBy)
```
    Sort results. Supported values are "name", "name desc" or "" (unsorted).
  - getPageSize
```
public java.lang.Integer getPageSize()
```
    The maximum number of items to return.
  - setPageSize
```
public CloudFilestore.Projects.Locations.Instances.List setPageSize(java.lang.Integer pageSize)
```
    The maximum number of items to return.
  - set
```
public CloudFilestore.Projects.Locations.Instances.List set(java.lang.String parameterName,
                                                            java.lang.Object value)
```
    Overrides:
    
    set in class CloudFilestoreRequest<ListInstancesResponse>

Cloud Filestore API v1 (revision 22)

Class CloudFilestore.Projects.Locations.Instances.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.file.v1.CloudFilestoreRequest

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

getParent

setParent

getFilter

setFilter

getPageToken

setPageToken

getOrderBy

setOrderBy

getPageSize

setPageSize

set