CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List (Cloud Key Management Service (KMS) API v1-rev20221107-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,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.cloudkms.v1.CloudKMSRequest<ListCryptoKeysResponse>
        
        com.google.api.services.cloudkms.v1.CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CloudKMS.Projects.Locations.KeyRings.CryptoKeys
```
public class CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List
extends CloudKMSRequest<ListCryptoKeysResponse>
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  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(String parent)
Lists CryptoKeys.

Constructors
Modifier	Constructor and Description
`protected`	`List(String parent)` Lists CryptoKeys.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeUsingHead()`
`String`	`getFilter()` Optional.
`String`	`getOrderBy()` Optional.
`Integer`	`getPageSize()` Optional.
`String`	`getPageToken()` Optional.
`String`	`getParent()` Required.
`String`	`getVersionView()` The fields of the primary version to include in the response.
`CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List`	`set(String parameterName, Object value)`
`CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List`	`setAccessToken(String accessToken)` OAuth access token.
`CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List`	`setAlt(String alt)` Data format for response.
`CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List`	`setCallback(String callback)` JSONP
`CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List`	`setFilter(String filter)` Optional.
`CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List`	`setKey(String key)` API key.
`CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List`	`setOrderBy(String orderBy)` Optional.
`CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List`	`setPageSize(Integer pageSize)` Optional.
`CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List`	`setPageToken(String pageToken)` Optional.
`CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List`	`setParent(String parent)` Required.
`CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.
`CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List`	`setVersionView(String versionView)` The fields of the primary version to include in the response.

Methods inherited from class com.google.api.services.cloudkms.v1.CloudKMSRequest
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.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, 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(String parent)
```
    Lists CryptoKeys. Create a request for the method "cryptoKeys.list". This request holds the parameters needed by the the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    CloudKMS.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    parent - Required. The resource name of the KeyRing to list, in the format `projects/locations/keyRings`.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public HttpResponse executeUsingHead()
                              throws IOException
```
    Overrides:
    
    executeUsingHead in class AbstractGoogleClientRequest<ListCryptoKeysResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ListCryptoKeysResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List set$Xgafv(String $Xgafv)
```
    Description copied from class: CloudKMSRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class CloudKMSRequest<ListCryptoKeysResponse>
  - setAccessToken
```
public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List setAccessToken(String accessToken)
```
    Description copied from class: CloudKMSRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class CloudKMSRequest<ListCryptoKeysResponse>
  - setAlt
```
public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List setAlt(String alt)
```
    Description copied from class: CloudKMSRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class CloudKMSRequest<ListCryptoKeysResponse>
  - setCallback
```
public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List setCallback(String callback)
```
    Description copied from class: CloudKMSRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class CloudKMSRequest<ListCryptoKeysResponse>
  - setFields
```
public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List setFields(String fields)
```
    Description copied from class: CloudKMSRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class CloudKMSRequest<ListCryptoKeysResponse>
  - setKey
```
public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List setKey(String key)
```
    Description copied from class: CloudKMSRequest
    
    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 CloudKMSRequest<ListCryptoKeysResponse>
  - setOauthToken
```
public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List setOauthToken(String oauthToken)
```
    Description copied from class: CloudKMSRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class CloudKMSRequest<ListCryptoKeysResponse>
  - setPrettyPrint
```
public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: CloudKMSRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class CloudKMSRequest<ListCryptoKeysResponse>
  - setQuotaUser
```
public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List setQuotaUser(String quotaUser)
```
    Description copied from class: CloudKMSRequest
    
    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 CloudKMSRequest<ListCryptoKeysResponse>
  - setUploadType
```
public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List setUploadType(String uploadType)
```
    Description copied from class: CloudKMSRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class CloudKMSRequest<ListCryptoKeysResponse>
  - setUploadProtocol
```
public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: CloudKMSRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class CloudKMSRequest<ListCryptoKeysResponse>
  - getParent
```
public String getParent()
```
    Required. The resource name of the KeyRing to list, in the format `projects/locations/keyRings`.
  - setParent
```
public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List setParent(String parent)
```
    Required. The resource name of the KeyRing to list, in the format `projects/locations/keyRings`.
  - getFilter
```
public String getFilter()
```
    Optional. Only include resources that match the filter in the response. For more information, see [Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-and-filtering).
  - setFilter
```
public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List setFilter(String filter)
```
    Optional. Only include resources that match the filter in the response. For more information, see [Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-and-filtering).
  - getOrderBy
```
public String getOrderBy()
```
    Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see [Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-and-filtering).
  - setOrderBy
```
public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List setOrderBy(String orderBy)
```
    Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see [Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-and-filtering).
  - getPageSize
```
public Integer getPageSize()
```
    Optional. Optional limit on the number of CryptoKeys to include in the response. Further CryptoKeys can subsequently be obtained by including the ListCryptoKeysResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
  - setPageSize
```
public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List setPageSize(Integer pageSize)
```
    Optional. Optional limit on the number of CryptoKeys to include in the response. Further CryptoKeys can subsequently be obtained by including the ListCryptoKeysResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
  - getPageToken
```
public String getPageToken()
```
    Optional. Optional pagination token, returned earlier via ListCryptoKeysResponse.next_page_token.
  - setPageToken
```
public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List setPageToken(String pageToken)
```
    Optional. Optional pagination token, returned earlier via ListCryptoKeysResponse.next_page_token.
  - getVersionView
```
public String getVersionView()
```
    The fields of the primary version to include in the response.
  - setVersionView
```
public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List setVersionView(String versionView)
```
    The fields of the primary version to include in the response.
  - set
```
public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.List set(String parameterName,
                                                                Object value)
```
    Overrides:
    
    set in class CloudKMSRequest<ListCryptoKeysResponse>

Class CloudKMS.Projects.Locations.KeyRings.CryptoKeys.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.cloudkms.v1.CloudKMSRequest

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

getOrderBy

setOrderBy

getPageSize

setPageSize

getPageToken

setPageToken

getVersionView

setVersionView

set