target.apidocs.com.google.api.services.compute.model.AWSV4Signature.html Maven / Gradle / Ivy
AWSV4Signature (Compute Engine API v1-rev20250107-2.0.0)
com.google.api.services.compute.model
Class AWSV4Signature
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.compute.model.AWSV4Signature
-
public final class AWSV4Signature
extends com.google.api.client.json.GenericJson
Contains the configurations necessary to generate a signature for access to private storage
buckets that support Signature Version 4 for authentication. The service name for generating the
authentication header will always default to 's3'.
This is the Java data model class that specifies how to parse/serialize into the JSON that is
transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see:
https://developers.google.com/api-client-library/java/google-http-java-client/json
- Author:
- Google, Inc.
-
-
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
Constructor and Description
AWSV4Signature()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
AWSV4Signature
clone()
String
getAccessKey()
The access key used for s3 bucket authentication.
String
getAccessKeyId()
The identifier of an access key used for s3 bucket authentication.
String
getAccessKeyVersion()
The optional version identifier for the access key.
String
getOriginRegion()
The name of the cloud region of your origin.
AWSV4Signature
set(String fieldName,
Object value)
AWSV4Signature
setAccessKey(String accessKey)
The access key used for s3 bucket authentication.
AWSV4Signature
setAccessKeyId(String accessKeyId)
The identifier of an access key used for s3 bucket authentication.
AWSV4Signature
setAccessKeyVersion(String accessKeyVersion)
The optional version identifier for the access key.
AWSV4Signature
setOriginRegion(String originRegion)
The name of the cloud region of your origin.
-
Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString
-
Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
-
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
-
-
Method Detail
-
getAccessKey
public String getAccessKey()
The access key used for s3 bucket authentication. Required for updating or creating a backend
that uses AWS v4 signature authentication, but will not be returned as part of the
configuration when queried with a REST API GET request. @InputOnly
- Returns:
- value or
null for none
-
setAccessKey
public AWSV4Signature setAccessKey(String accessKey)
The access key used for s3 bucket authentication. Required for updating or creating a backend
that uses AWS v4 signature authentication, but will not be returned as part of the
configuration when queried with a REST API GET request. @InputOnly
- Parameters:
accessKey - accessKey or null for none
-
getAccessKeyId
public String getAccessKeyId()
The identifier of an access key used for s3 bucket authentication.
- Returns:
- value or
null for none
-
setAccessKeyId
public AWSV4Signature setAccessKeyId(String accessKeyId)
The identifier of an access key used for s3 bucket authentication.
- Parameters:
accessKeyId - accessKeyId or null for none
-
getAccessKeyVersion
public String getAccessKeyVersion()
The optional version identifier for the access key. You can use this to keep track of different
iterations of your access key.
- Returns:
- value or
null for none
-
setAccessKeyVersion
public AWSV4Signature setAccessKeyVersion(String accessKeyVersion)
The optional version identifier for the access key. You can use this to keep track of different
iterations of your access key.
- Parameters:
accessKeyVersion - accessKeyVersion or null for none
-
getOriginRegion
public String getOriginRegion()
The name of the cloud region of your origin. This is a free-form field with the name of the
region your cloud uses to host your origin. For example, "us-east-1" for AWS or "us-ashburn-1"
for OCI.
- Returns:
- value or
null for none
-
setOriginRegion
public AWSV4Signature setOriginRegion(String originRegion)
The name of the cloud region of your origin. This is a free-form field with the name of the
region your cloud uses to host your origin. For example, "us-east-1" for AWS or "us-ashburn-1"
for OCI.
- Parameters:
originRegion - originRegion or null for none
-
set
public AWSV4Signature set(String fieldName,
Object value)
- Overrides:
set in class com.google.api.client.json.GenericJson
-
clone
public AWSV4Signature clone()
- Overrides:
clone in class com.google.api.client.json.GenericJson
Copyright © 2011–2025 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy