FirebaseRules.Projects.Releases.List (Firebase Rules API v1 (Rev. 306) 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.firebaserules.v1.FirebaseRulesRequest<ListReleasesResponse>
        
        com.google.api.services.firebaserules.v1.FirebaseRules.Projects.Releases.List

All Implemented Interfaces:

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

Enclosing class:

FirebaseRules.Projects.Releases
```
public class FirebaseRules.Projects.Releases.List
extends FirebaseRulesRequest<ListReleasesResponse>
```

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)
List the `Release` values for a project.

Constructors
Modifier	Constructor and Description
`protected`	`List(java.lang.String name)` List the `Release` values for a project.

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()` ` Release` filter.
`java.lang.String`	`getName()` Resource name for the project.
`java.lang.Integer`	`getPageSize()` Page size to load.
`java.lang.String`	`getPageToken()` Next page token for the next batch of `Release` instances.
`FirebaseRules.Projects.Releases.List`	`set(java.lang.String parameterName, java.lang.Object value)`
`FirebaseRules.Projects.Releases.List`	`set$Xgafv(java.lang.String $Xgafv)` V1 error format.
`FirebaseRules.Projects.Releases.List`	`setAccessToken(java.lang.String accessToken)` OAuth access token.
`FirebaseRules.Projects.Releases.List`	`setAlt(java.lang.String alt)` Data format for response.
`FirebaseRules.Projects.Releases.List`	`setCallback(java.lang.String callback)` JSONP
`FirebaseRules.Projects.Releases.List`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`FirebaseRules.Projects.Releases.List`	`setFilter(java.lang.String filter)` `Release` filter.
`FirebaseRules.Projects.Releases.List`	`setKey(java.lang.String key)` API key.
`FirebaseRules.Projects.Releases.List`	`setName(java.lang.String name)` Resource name for the project.
`FirebaseRules.Projects.Releases.List`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`FirebaseRules.Projects.Releases.List`	`setPageSize(java.lang.Integer pageSize)` Page size to load.
`FirebaseRules.Projects.Releases.List`	`setPageToken(java.lang.String pageToken)` Next page token for the next batch of `Release` instances.
`FirebaseRules.Projects.Releases.List`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`FirebaseRules.Projects.Releases.List`	`setQuotaUser(java.lang.String quotaUser)` Available to use for quota purposes for server-side applications.
`FirebaseRules.Projects.Releases.List`	`setUploadProtocol(java.lang.String uploadProtocol)` Upload protocol for media (e.g.
`FirebaseRules.Projects.Releases.List`	`setUploadType(java.lang.String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.firebaserules.v1.FirebaseRulesRequest
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)
```
    List the `Release` values for a project. This list may optionally be filtered by `Release` name, `Ruleset` name, `TestSuite` name, or any combination thereof. Create a request for the method "releases.list". This request holds the parameters needed by the the firebaserules server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    FirebaseRules.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    name - Resource name for the project. Format: `projects/{project_id}`
    
    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<ListReleasesResponse>
    
    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<ListReleasesResponse>
    
    Throws:
    
    java.io.IOException
  - set$Xgafv
```
public FirebaseRules.Projects.Releases.List set$Xgafv(java.lang.String $Xgafv)
```
    Description copied from class: FirebaseRulesRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class FirebaseRulesRequest<ListReleasesResponse>
  - setAccessToken
```
public FirebaseRules.Projects.Releases.List setAccessToken(java.lang.String accessToken)
```
    Description copied from class: FirebaseRulesRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class FirebaseRulesRequest<ListReleasesResponse>
  - setAlt
```
public FirebaseRules.Projects.Releases.List setAlt(java.lang.String alt)
```
    Description copied from class: FirebaseRulesRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class FirebaseRulesRequest<ListReleasesResponse>
  - setCallback
```
public FirebaseRules.Projects.Releases.List setCallback(java.lang.String callback)
```
    Description copied from class: FirebaseRulesRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class FirebaseRulesRequest<ListReleasesResponse>
  - setFields
```
public FirebaseRules.Projects.Releases.List setFields(java.lang.String fields)
```
    Description copied from class: FirebaseRulesRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class FirebaseRulesRequest<ListReleasesResponse>
  - setKey
```
public FirebaseRules.Projects.Releases.List setKey(java.lang.String key)
```
    Description copied from class: FirebaseRulesRequest
    
    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 FirebaseRulesRequest<ListReleasesResponse>
  - setOauthToken
```
public FirebaseRules.Projects.Releases.List setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: FirebaseRulesRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class FirebaseRulesRequest<ListReleasesResponse>
  - setPrettyPrint
```
public FirebaseRules.Projects.Releases.List setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: FirebaseRulesRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class FirebaseRulesRequest<ListReleasesResponse>
  - setQuotaUser
```
public FirebaseRules.Projects.Releases.List setQuotaUser(java.lang.String quotaUser)
```
    Description copied from class: FirebaseRulesRequest
    
    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 FirebaseRulesRequest<ListReleasesResponse>
  - setUploadType
```
public FirebaseRules.Projects.Releases.List setUploadType(java.lang.String uploadType)
```
    Description copied from class: FirebaseRulesRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class FirebaseRulesRequest<ListReleasesResponse>
  - setUploadProtocol
```
public FirebaseRules.Projects.Releases.List setUploadProtocol(java.lang.String uploadProtocol)
```
    Description copied from class: FirebaseRulesRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class FirebaseRulesRequest<ListReleasesResponse>
  - getName
```
public java.lang.String getName()
```
    Resource name for the project. Format: `projects/{project_id}`
  - setName
```
public FirebaseRules.Projects.Releases.List setName(java.lang.String name)
```
    Resource name for the project. Format: `projects/{project_id}`
  - getFilter
```
public java.lang.String getFilter()
```
    ` Release` filter. The list method supports filters with restrictions on the Release.name`, ` `Release.ruleset_name`, and `Release.test_suite_name`. ` ` Example 1: A filter of 'name=prod*' might return `Release`s with names within 'projects/foo' ` prefixed with 'prod': ` ` Name | Ruleset Name ------------------------------|------------- ` projects/foo/releases/prod | projects/foo/rulesets/uuid1234 projects/foo/releases/prod/v1 | ` projects/foo/rulesets/uuid1234 projects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888 ` ` Example 2: A filter of `name=prod* ruleset_name=uuid1234` would return only Release` instances for ` 'projects/foo' with names prefixed with 'prod' referring to the same `Ruleset` name of 'uuid1234': ` ` Name | Ruleset Name ------------------------------|------------- ` projects/foo/releases/prod | projects/foo/rulesets/1234 projects/foo/releases/prod/v1 | ` projects/foo/rulesets/1234 ` ` In the examples, the filter parameters refer to the search filters are relative to the project. ` Fully qualified prefixed may also be used. e.g. test_suite_name=projects/foo/testsuites/uuid1` `
  - setFilter
```
public FirebaseRules.Projects.Releases.List setFilter(java.lang.String filter)
```
    `Release` filter. The list method supports filters with restrictions on the `Release.name`, `Release.ruleset_name`, and `Release.test_suite_name`. Example 1: A filter of 'name=prod*' might return `Release`s with names within 'projects/foo' prefixed with 'prod': Name | Ruleset Name ------------------------------|------------- projects/foo/releases/prod | projects/foo/rulesets/uuid1234 projects/foo/releases/prod/v1 | projects/foo/rulesets/uuid1234 projects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888 Example 2: A filter of `name=prod* ruleset_name=uuid1234` would return only `Release` instances for 'projects/foo' with names prefixed with 'prod' referring to the same `Ruleset` name of 'uuid1234': Name | Ruleset Name ------------------------------|------------- projects/foo/releases/prod | projects/foo/rulesets/1234 projects/foo/releases/prod/v1 | projects/foo/rulesets/1234 In the examples, the filter parameters refer to the search filters are relative to the project. Fully qualified prefixed may also be used. e.g. `test_suite_name=projects/foo/testsuites/uuid1`
  - getPageToken
```
public java.lang.String getPageToken()
```
    Next page token for the next batch of `Release` instances.
  - setPageToken
```
public FirebaseRules.Projects.Releases.List setPageToken(java.lang.String pageToken)
```
    Next page token for the next batch of `Release` instances.
  - getPageSize
```
public java.lang.Integer getPageSize()
```
    Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a hint and the service may choose to load fewer than `page_size` results due to the size of the output. To traverse all of the releases, the caller should iterate until the `page_token` on the response is empty.
  - setPageSize
```
public FirebaseRules.Projects.Releases.List setPageSize(java.lang.Integer pageSize)
```
    Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a hint and the service may choose to load fewer than `page_size` results due to the size of the output. To traverse all of the releases, the caller should iterate until the `page_token` on the response is empty.
  - set
```
public FirebaseRules.Projects.Releases.List set(java.lang.String parameterName,
                                                java.lang.Object value)
```
    Overrides:
    
    set in class FirebaseRulesRequest<ListReleasesResponse>

Firebase Rules API v1 (revision 306)

Class FirebaseRules.Projects.Releases.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.firebaserules.v1.FirebaseRulesRequest

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

getFilter

setFilter

getPageToken

setPageToken

getPageSize

setPageSize

set