target.apidocs.com.google.api.services.cloudkms.v1.CloudKMS.Projects.Locations.EkmConnections.VerifyConnectivity.html Maven / Gradle / Ivy
CloudKMS.Projects.Locations.EkmConnections.VerifyConnectivity (Cloud Key Management Service (KMS) API v1-rev20240801-2.0.0)
com.google.api.services.cloudkms.v1
Class CloudKMS.Projects.Locations.EkmConnections.VerifyConnectivity
- 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<VerifyConnectivityResponse>
-
- com.google.api.services.cloudkms.v1.CloudKMS.Projects.Locations.EkmConnections.VerifyConnectivity
-
- Enclosing class:
- CloudKMS.Projects.Locations.EkmConnections
public class CloudKMS.Projects.Locations.EkmConnections.VerifyConnectivity
extends CloudKMSRequest<VerifyConnectivityResponse>
-
-
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
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected VerifyConnectivity(String name)
Verifies that Cloud KMS can successfully connect to the external key manager specified by an
EkmConnection.
-
Method Summary
-
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
-
VerifyConnectivity
protected VerifyConnectivity(String name)
Verifies that Cloud KMS can successfully connect to the external key manager specified by an
EkmConnection. If there is an error connecting to the EKM, this method returns a
FAILED_PRECONDITION status containing structured information as described at
https://cloud.google.com/kms/docs/reference/ekm_errors.
Create a request for the method "ekmConnections.verifyConnectivity".
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. VerifyConnectivity#initialize(com.google.api.client.googleapis.services.A
bstractGoogleClientRequest) must be called to initialize this instance immediately after
invoking the constructor.
- Parameters:
name - Required. The name of the EkmConnection to verify.- Since:
- 1.13
-
Method Detail
-
executeUsingHead
public com.google.api.client.http.HttpResponse executeUsingHead()
throws IOException
- Overrides:
executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<VerifyConnectivityResponse>- Throws:
IOException
-
buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<VerifyConnectivityResponse>- Throws:
IOException
-
set$Xgafv
public CloudKMS.Projects.Locations.EkmConnections.VerifyConnectivity set$Xgafv(String $Xgafv)
Description copied from class: CloudKMSRequest
V1 error format.
- Overrides:
set$Xgafv in class CloudKMSRequest<VerifyConnectivityResponse>
-
setAccessToken
public CloudKMS.Projects.Locations.EkmConnections.VerifyConnectivity setAccessToken(String accessToken)
Description copied from class: CloudKMSRequest
OAuth access token.
- Overrides:
setAccessToken in class CloudKMSRequest<VerifyConnectivityResponse>
-
setAlt
public CloudKMS.Projects.Locations.EkmConnections.VerifyConnectivity setAlt(String alt)
Description copied from class: CloudKMSRequest
Data format for response.
- Overrides:
setAlt in class CloudKMSRequest<VerifyConnectivityResponse>
-
setCallback
public CloudKMS.Projects.Locations.EkmConnections.VerifyConnectivity setCallback(String callback)
Description copied from class: CloudKMSRequest
JSONP
- Overrides:
setCallback in class CloudKMSRequest<VerifyConnectivityResponse>
-
setFields
public CloudKMS.Projects.Locations.EkmConnections.VerifyConnectivity setFields(String fields)
Description copied from class: CloudKMSRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields in class CloudKMSRequest<VerifyConnectivityResponse>
-
setKey
public CloudKMS.Projects.Locations.EkmConnections.VerifyConnectivity 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<VerifyConnectivityResponse>
-
setOauthToken
public CloudKMS.Projects.Locations.EkmConnections.VerifyConnectivity setOauthToken(String oauthToken)
Description copied from class: CloudKMSRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken in class CloudKMSRequest<VerifyConnectivityResponse>
-
setPrettyPrint
public CloudKMS.Projects.Locations.EkmConnections.VerifyConnectivity setPrettyPrint(Boolean prettyPrint)
Description copied from class: CloudKMSRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint in class CloudKMSRequest<VerifyConnectivityResponse>
-
setQuotaUser
public CloudKMS.Projects.Locations.EkmConnections.VerifyConnectivity 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<VerifyConnectivityResponse>
-
setUploadType
public CloudKMS.Projects.Locations.EkmConnections.VerifyConnectivity setUploadType(String uploadType)
Description copied from class: CloudKMSRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType in class CloudKMSRequest<VerifyConnectivityResponse>
-
setUploadProtocol
public CloudKMS.Projects.Locations.EkmConnections.VerifyConnectivity setUploadProtocol(String uploadProtocol)
Description copied from class: CloudKMSRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol in class CloudKMSRequest<VerifyConnectivityResponse>
-
getName
public String getName()
Required. The name of the EkmConnection to verify.
-
setName
public CloudKMS.Projects.Locations.EkmConnections.VerifyConnectivity setName(String name)
Required. The name of the EkmConnection to verify.
-
set
public CloudKMS.Projects.Locations.EkmConnections.VerifyConnectivity set(String parameterName,
Object value)
- Overrides:
set in class CloudKMSRequest<VerifyConnectivityResponse>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy