com.google.api.services.cloudkms.v1

Class CloudKMS.Projects.Locations.KeyRings.List

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<ListKeyRingsResponse>

com.google.api.services.cloudkms.v1.CloudKMS.Projects.Locations.KeyRings.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CloudKMS.Projects.Locations.KeyRings

public class CloudKMS.Projects.Locations.KeyRings.List
extends CloudKMSRequest<ListKeyRingsResponse>

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 KeyRings.

Method Summary

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.
CloudKMS.Projects.Locations.KeyRings.List	set(String parameterName, Object value)
CloudKMS.Projects.Locations.KeyRings.List	set$Xgafv(String $Xgafv) V1 error format.
CloudKMS.Projects.Locations.KeyRings.List	setAccessToken(String accessToken) OAuth access token.
CloudKMS.Projects.Locations.KeyRings.List	setAlt(String alt) Data format for response.
CloudKMS.Projects.Locations.KeyRings.List	setCallback(String callback) JSONP
CloudKMS.Projects.Locations.KeyRings.List	setFields(String fields) Selector specifying which fields to include in a partial response.
CloudKMS.Projects.Locations.KeyRings.List	setFilter(String filter) Optional.
CloudKMS.Projects.Locations.KeyRings.List	setKey(String key) API key.
CloudKMS.Projects.Locations.KeyRings.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
CloudKMS.Projects.Locations.KeyRings.List	setOrderBy(String orderBy) Optional.
CloudKMS.Projects.Locations.KeyRings.List	setPageSize(Integer pageSize) Optional.
CloudKMS.Projects.Locations.KeyRings.List	setPageToken(String pageToken) Optional.
CloudKMS.Projects.Locations.KeyRings.List	setParent(String parent) Required.
CloudKMS.Projects.Locations.KeyRings.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
CloudKMS.Projects.Locations.KeyRings.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
CloudKMS.Projects.Locations.KeyRings.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
CloudKMS.Projects.Locations.KeyRings.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

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.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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 KeyRings. Create a request for the method "keyRings.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 location associated with the KeyRings, in the format `projects/locations`.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<ListKeyRingsResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ListKeyRingsResponse>

Throws:

IOException

set$Xgafv

public CloudKMS.Projects.Locations.KeyRings.List set$Xgafv(String $Xgafv)

Description copied from class: CloudKMSRequest

V1 error format.

Overrides:

set$Xgafv in class CloudKMSRequest<ListKeyRingsResponse>

setAccessToken

public CloudKMS.Projects.Locations.KeyRings.List setAccessToken(String accessToken)

Description copied from class: CloudKMSRequest

OAuth access token.

Overrides:

setAccessToken in class CloudKMSRequest<ListKeyRingsResponse>

setAlt

public CloudKMS.Projects.Locations.KeyRings.List setAlt(String alt)

Description copied from class: CloudKMSRequest

Data format for response.

Overrides:

setAlt in class CloudKMSRequest<ListKeyRingsResponse>

setCallback

public CloudKMS.Projects.Locations.KeyRings.List setCallback(String callback)

Description copied from class: CloudKMSRequest

JSONP

Overrides:

setCallback in class CloudKMSRequest<ListKeyRingsResponse>

setFields

public CloudKMS.Projects.Locations.KeyRings.List setFields(String fields)

Description copied from class: CloudKMSRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CloudKMSRequest<ListKeyRingsResponse>

setKey

public CloudKMS.Projects.Locations.KeyRings.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<ListKeyRingsResponse>

setOauthToken

public CloudKMS.Projects.Locations.KeyRings.List setOauthToken(String oauthToken)

Description copied from class: CloudKMSRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CloudKMSRequest<ListKeyRingsResponse>

setPrettyPrint

public CloudKMS.Projects.Locations.KeyRings.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: CloudKMSRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CloudKMSRequest<ListKeyRingsResponse>

setQuotaUser

public CloudKMS.Projects.Locations.KeyRings.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<ListKeyRingsResponse>

setUploadType

public CloudKMS.Projects.Locations.KeyRings.List setUploadType(String uploadType)

Description copied from class: CloudKMSRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class CloudKMSRequest<ListKeyRingsResponse>

setUploadProtocol

public CloudKMS.Projects.Locations.KeyRings.List setUploadProtocol(String uploadProtocol)

Description copied from class: CloudKMSRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class CloudKMSRequest<ListKeyRingsResponse>

getParent

public String getParent()

Required. The resource name of the location associated with the KeyRings, in the format `projects/locations`.

setParent

public CloudKMS.Projects.Locations.KeyRings.List setParent(String parent)

Required. The resource name of the location associated with the KeyRings, in the format `projects/locations`.

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.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.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 KeyRings to include in the response. Further KeyRings can subsequently be obtained by including the ListKeyRingsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.

setPageSize

public CloudKMS.Projects.Locations.KeyRings.List setPageSize(Integer pageSize)

Optional. Optional limit on the number of KeyRings to include in the response. Further KeyRings can subsequently be obtained by including the ListKeyRingsResponse.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 ListKeyRingsResponse.next_page_token.

setPageToken

public CloudKMS.Projects.Locations.KeyRings.List setPageToken(String pageToken)

Optional. Optional pagination token, returned earlier via ListKeyRingsResponse.next_page_token.

set

public CloudKMS.Projects.Locations.KeyRings.List set(String parameterName,
                                                     Object value)

Overrides:

set in class CloudKMSRequest<ListKeyRingsResponse>