com.google.cloud.storage.JsonConversions Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-storage Show documentation
Show all versions of google-cloud-storage Show documentation
Java idiomatic client for Google Cloud Storage.
/*
* Copyright 2022 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.storage;
import static com.google.cloud.storage.Storage.BucketField.SOFT_DELETE_POLICY;
import static com.google.cloud.storage.Utils.dateTimeCodec;
import static com.google.cloud.storage.Utils.durationSecondsCodec;
import static com.google.cloud.storage.Utils.ifNonNull;
import static com.google.cloud.storage.Utils.lift;
import static com.google.cloud.storage.Utils.nullableDateTimeCodec;
import static com.google.cloud.storage.Utils.projectNameCodec;
import static com.google.common.base.MoreObjects.firstNonNull;
import com.google.api.client.util.Data;
import com.google.api.client.util.DateTime;
import com.google.api.core.InternalApi;
import com.google.api.services.storage.model.Bucket;
import com.google.api.services.storage.model.Bucket.Billing;
import com.google.api.services.storage.model.Bucket.Encryption;
import com.google.api.services.storage.model.Bucket.IamConfiguration.UniformBucketLevelAccess;
import com.google.api.services.storage.model.Bucket.Lifecycle;
import com.google.api.services.storage.model.Bucket.Lifecycle.Rule;
import com.google.api.services.storage.model.Bucket.Lifecycle.Rule.Action;
import com.google.api.services.storage.model.Bucket.Lifecycle.Rule.Condition;
import com.google.api.services.storage.model.Bucket.RetentionPolicy;
import com.google.api.services.storage.model.Bucket.Versioning;
import com.google.api.services.storage.model.Bucket.Website;
import com.google.api.services.storage.model.BucketAccessControl;
import com.google.api.services.storage.model.ObjectAccessControl;
import com.google.api.services.storage.model.Policy.Bindings;
import com.google.api.services.storage.model.StorageObject;
import com.google.api.services.storage.model.StorageObject.Owner;
import com.google.cloud.Binding;
import com.google.cloud.Policy;
import com.google.cloud.storage.Acl.Domain;
import com.google.cloud.storage.Acl.Entity;
import com.google.cloud.storage.Acl.Group;
import com.google.cloud.storage.Acl.Project;
import com.google.cloud.storage.Acl.RawEntity;
import com.google.cloud.storage.Acl.Role;
import com.google.cloud.storage.Acl.User;
import com.google.cloud.storage.BlobInfo.CustomerEncryption;
import com.google.cloud.storage.BlobInfo.Retention;
import com.google.cloud.storage.BucketInfo.Autoclass;
import com.google.cloud.storage.BucketInfo.CustomPlacementConfig;
import com.google.cloud.storage.BucketInfo.IamConfiguration;
import com.google.cloud.storage.BucketInfo.LifecycleRule;
import com.google.cloud.storage.BucketInfo.LifecycleRule.AbortIncompleteMPUAction;
import com.google.cloud.storage.BucketInfo.LifecycleRule.DeleteLifecycleAction;
import com.google.cloud.storage.BucketInfo.LifecycleRule.LifecycleAction;
import com.google.cloud.storage.BucketInfo.LifecycleRule.LifecycleCondition;
import com.google.cloud.storage.BucketInfo.LifecycleRule.SetStorageClassLifecycleAction;
import com.google.cloud.storage.BucketInfo.Logging;
import com.google.cloud.storage.BucketInfo.ObjectRetention;
import com.google.cloud.storage.BucketInfo.PublicAccessPrevention;
import com.google.cloud.storage.BucketInfo.SoftDeletePolicy;
import com.google.cloud.storage.Conversions.Codec;
import com.google.cloud.storage.Cors.Origin;
import com.google.cloud.storage.HmacKey.HmacKeyMetadata;
import com.google.cloud.storage.HmacKey.HmacKeyState;
import com.google.cloud.storage.NotificationInfo.EventType;
import com.google.cloud.storage.NotificationInfo.PayloadFormat;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Maps;
import java.math.BigInteger;
import java.time.OffsetDateTime;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Objects;
import java.util.function.Function;
import java.util.stream.Collectors;
@InternalApi
final class JsonConversions {
static final JsonConversions INSTANCE = new JsonConversions();
// gRPC has a Bucket.project property that apiary doesn't have yet.
// when converting from gRPC to apiary or vice-versa we want to preserve this property. Until
// such a time as the apiary model has a project field, we manually apply it with this name.
private static final String PROJECT_ID_FIELD_NAME = "x_project";
// gRPC has a NotificationConfig.name property which contains the bucket the config is associated
// with which that apiary doesn't have yet.
// when converting from gRPC to apiary or vice-versa we want to preserve this property. Until
// such a time as the apiary model has a bucket field, we manually apply it with this name.
private static final String NOTIFICATION_BUCKET_FIELD_NAME = "x_bucket";
private final Codec entityCodec =
Codec.of(this::entityEncode, this::entityDecode);
private final Codec objectAclCodec =
Codec.of(this::objectAclEncode, this::objectAclDecode);
private final Codec bucketAclCodec =
Codec.of(this::bucketAclEncode, this::bucketAclDecode);
private final Codec
hmacKeyMetadataCodec = Codec.of(this::hmacKeyMetadataEncode, this::hmacKeyMetadataDecode);
private final Codec hmacKeyCodec =
Codec.of(this::hmacKeyEncode, this::hmacKeyDecode);
private final Codec
serviceAccountCodec = Codec.of(this::serviceAccountEncode, this::serviceAccountDecode);
private final Codec corsCodec = Codec.of(this::corsEncode, this::corsDecode);
private final Codec loggingCodec =
Codec.of(this::loggingEncode, this::loggingDecode);
private final Codec iamConfigurationCodec =
Codec.of(this::iamConfigEncode, this::iamConfigDecode);
private final Codec autoclassCodec =
Codec.of(this::autoclassEncode, this::autoclassDecode);
private final Codec objectRetentionCodec =
Codec.of(this::objectRetentionEncode, this::objectRetentionDecode);
private final Codec softDeletePolicyCodec =
Codec.of(this::softDeletePolicyEncode, this::softDeletePolicyDecode);
private final Codec lifecycleRuleCodec =
Codec.of(this::lifecycleRuleEncode, this::lifecycleRuleDecode);
private final Codec lifecycleConditionCodec =
Codec.of(this::ruleConditionEncode, this::ruleConditionDecode);
private final Codec bucketInfoCodec =
Codec.of(this::bucketInfoEncode, this::bucketInfoDecode);
private final Codec
customerEncryptionCodec =
Codec.of(this::customerEncryptionEncode, this::customerEncryptionDecode);
private final Codec retentionCodec =
Codec.of(this::retentionEncode, this::retentionDecode);
private final Codec blobIdCodec =
Codec.of(this::blobIdEncode, this::blobIdDecode);
private final Codec blobInfoCodec =
Codec.of(this::blobInfoEncode, this::blobInfoDecode);
private final Codec
hierarchicalNamespaceCodec =
Codec.of(this::hierarchicalNamespaceEncode, this::hierarchicalNamespaceDecode);
private final Codec
notificationInfoCodec = Codec.of(this::notificationEncode, this::notificationDecode);
private final Codec
customPlacementConfigCodec =
Codec.of(this::customPlacementConfigEncode, this::customPlacementConfigDecode);
private final Codec policyCodec =
Codec.of(this::policyEncode, this::policyDecode);
private final Codec bindingCodec =
Codec.of(this::bindingEncode, this::bindingDecode);
private final Codec
iamConditionCodec = Codec.of(this::conditionEncode, this::conditionDecode);
private JsonConversions() {}
Codec entity() {
return entityCodec;
}
Codec objectAcl() {
return objectAclCodec;
}
Codec bucketAcl() {
return bucketAclCodec;
}
Codec hmacKeyMetadata() {
return hmacKeyMetadataCodec;
}
Codec hmacKey() {
return hmacKeyCodec;
}
Codec serviceAccount() {
return serviceAccountCodec;
}
Codec cors() {
return corsCodec;
}
Codec logging() {
return loggingCodec;
}
Codec iamConfiguration() {
return iamConfigurationCodec;
}
Codec lifecycleRule() {
return lifecycleRuleCodec;
}
Codec bucketInfo() {
return bucketInfoCodec;
}
Codec customerEncryption() {
return customerEncryptionCodec;
}
Codec blobId() {
return blobIdCodec;
}
Codec blobInfo() {
return blobInfoCodec;
}
Codec notificationInfo() {
return notificationInfoCodec;
}
Codec lifecycleCondition() {
return lifecycleConditionCodec;
}
Codec customPlacementConfig() {
return customPlacementConfigCodec;
}
Codec policyCodec() {
return policyCodec;
}
private StorageObject blobInfoEncode(BlobInfo from) {
StorageObject to = blobIdEncode(from.getBlobId());
ifNonNull(from.getAcl(), toListOf(objectAcl()::encode), to::setAcl);
ifNonNull(from.getDeleteTimeOffsetDateTime(), dateTimeCodec::encode, to::setTimeDeleted);
ifNonNull(from.getUpdateTimeOffsetDateTime(), dateTimeCodec::encode, to::setUpdated);
ifNonNull(from.getCreateTimeOffsetDateTime(), dateTimeCodec::encode, to::setTimeCreated);
ifNonNull(from.getCustomTimeOffsetDateTime(), dateTimeCodec::encode, to::setCustomTime);
ifNonNull(from.getSize(), BigInteger::valueOf, to::setSize);
ifNonNull(
from.getOwner(),
lift(this::entityEncode).andThen(o -> new Owner().setEntity(o)),
to::setOwner);
ifNonNull(from.getStorageClass(), StorageClass::toString, to::setStorageClass);
ifNonNull(
from.getTimeStorageClassUpdatedOffsetDateTime(),
dateTimeCodec::encode,
to::setTimeStorageClassUpdated);
ifNonNull(
from.getCustomerEncryption(), this::customerEncryptionEncode, to::setCustomerEncryption);
ifNonNull(
from.getRetentionExpirationTimeOffsetDateTime(),
dateTimeCodec::encode,
to::setRetentionExpirationTime);
ifNonNull(from.getSoftDeleteTime(), dateTimeCodec::encode, to::setSoftDeleteTime);
ifNonNull(from.getHardDeleteTime(), dateTimeCodec::encode, to::setHardDeleteTime);
// todo: clean this up once retention is enabled in grpc
// This is a workaround so that explicitly null retention objects are only included when the
// user set an existing policy to null, to avoid sending any retention objects to the test
// bench.
// We should clean this up once the test bench can handle the retention field.
// See also the comment in StorageImpl.update(BlobInfo blobInfo, BlobTargetOption... options)
// todo: b/308194853
if (from.getModifiedFields().contains(Storage.BlobField.RETENTION)
&& from.getRetention() == null) {
to.setRetention(Data.nullOf(StorageObject.Retention.class));
}
ifNonNull(from.getRetention(), this::retentionEncode, to::setRetention);
to.setKmsKeyName(from.getKmsKeyName());
to.setEventBasedHold(from.getEventBasedHold());
to.setTemporaryHold(from.getTemporaryHold());
// Do not use, #getMetadata(), it can not return null, which is important to our logic here
Map pbMetadata = from.metadata;
if (pbMetadata != null && !Data.isNull(pbMetadata)) {
pbMetadata = Maps.newHashMapWithExpectedSize(from.getMetadata().size());
for (Map.Entry entry : from.getMetadata().entrySet()) {
pbMetadata.put(entry.getKey(), firstNonNull(entry.getValue(), Data.nullOf(String.class)));
}
}
to.setMetadata(pbMetadata);
to.setCacheControl(from.getCacheControl());
to.setContentEncoding(from.getContentEncoding());
to.setCrc32c(from.getCrc32c());
to.setContentType(from.getContentType());
to.setMd5Hash(from.getMd5());
to.setMediaLink(from.getMediaLink());
to.setMetageneration(from.getMetageneration());
to.setContentDisposition(from.getContentDisposition());
to.setComponentCount(from.getComponentCount());
to.setContentLanguage(from.getContentLanguage());
to.setEtag(from.getEtag());
to.setId(from.getGeneratedId());
to.setSelfLink(from.getSelfLink());
return to;
}
private BlobInfo blobInfoDecode(StorageObject from) {
BlobInfo.Builder to = BlobInfo.newBuilder(blobIdDecode(from));
ifNonNull(from.getCacheControl(), to::setCacheControl);
ifNonNull(from.getContentEncoding(), to::setContentEncoding);
ifNonNull(from.getCrc32c(), to::setCrc32c);
ifNonNull(from.getContentType(), to::setContentType);
ifNonNull(from.getMd5Hash(), to::setMd5);
ifNonNull(from.getMediaLink(), to::setMediaLink);
ifNonNull(from.getMetageneration(), to::setMetageneration);
ifNonNull(from.getContentDisposition(), to::setContentDisposition);
ifNonNull(from.getComponentCount(), to::setComponentCount);
ifNonNull(from.getContentLanguage(), to::setContentLanguage);
ifNonNull(from.getEtag(), to::setEtag);
ifNonNull(from.getId(), to::setGeneratedId);
ifNonNull(from.getSelfLink(), to::setSelfLink);
ifNonNull(from.getMetadata(), to::setMetadata);
ifNonNull(from.getTimeDeleted(), dateTimeCodec::decode, to::setDeleteTimeOffsetDateTime);
ifNonNull(from.getUpdated(), dateTimeCodec::decode, to::setUpdateTimeOffsetDateTime);
ifNonNull(from.getTimeCreated(), dateTimeCodec::decode, to::setCreateTimeOffsetDateTime);
ifNonNull(from.getCustomTime(), dateTimeCodec::decode, to::setCustomTimeOffsetDateTime);
ifNonNull(from.getSize(), BigInteger::longValue, to::setSize);
ifNonNull(from.getOwner(), lift(Owner::getEntity).andThen(this::entityDecode), to::setOwner);
ifNonNull(from.getAcl(), toListOf(objectAcl()::decode), to::setAcl);
if (from.containsKey("isDirectory")) {
to.setIsDirectory(Boolean.TRUE);
}
ifNonNull(
from.getCustomerEncryption(), this::customerEncryptionDecode, to::setCustomerEncryption);
ifNonNull(from.getStorageClass(), StorageClass::valueOf, to::setStorageClass);
ifNonNull(
from.getTimeStorageClassUpdated(),
dateTimeCodec::decode,
to::setTimeStorageClassUpdatedOffsetDateTime);
ifNonNull(from.getKmsKeyName(), to::setKmsKeyName);
ifNonNull(from.getEventBasedHold(), to::setEventBasedHold);
ifNonNull(from.getTemporaryHold(), to::setTemporaryHold);
ifNonNull(
from.getRetentionExpirationTime(),
dateTimeCodec::decode,
to::setRetentionExpirationTimeOffsetDateTime);
ifNonNull(from.getRetention(), this::retentionDecode, to::setRetention);
ifNonNull(from.getSoftDeleteTime(), dateTimeCodec::decode, to::setSoftDeleteTime);
ifNonNull(from.getHardDeleteTime(), dateTimeCodec::decode, to::setHardDeleteTime);
return to.build();
}
private StorageObject blobIdEncode(BlobId from) {
StorageObject to = new StorageObject();
to.setBucket(from.getBucket());
to.setName(from.getName());
to.setGeneration(from.getGeneration());
return to;
}
private BlobId blobIdDecode(StorageObject from) {
return BlobId.of(from.getBucket(), from.getName(), from.getGeneration());
}
private StorageObject.CustomerEncryption customerEncryptionEncode(CustomerEncryption from) {
return new StorageObject.CustomerEncryption()
.setEncryptionAlgorithm(from.getEncryptionAlgorithm())
.setKeySha256(from.getKeySha256());
}
private CustomerEncryption customerEncryptionDecode(StorageObject.CustomerEncryption from) {
return new CustomerEncryption(from.getEncryptionAlgorithm(), from.getKeySha256());
}
private StorageObject.Retention retentionEncode(Retention from) {
StorageObject.Retention to = new StorageObject.Retention();
ifNonNull(from.getMode(), Retention.Mode::toString, to::setMode);
ifNonNull(from.getRetainUntilTime(), dateTimeCodec::encode, to::setRetainUntilTime);
return to;
}
private Retention retentionDecode(StorageObject.Retention from) {
Retention.Builder to = Retention.newBuilder();
ifNonNull(from.getMode(), Retention.Mode::valueOf, to::setMode);
ifNonNull(from.getRetainUntilTime(), dateTimeCodec::decode, to::setRetainUntilTime);
return to.build();
}
private Bucket.SoftDeletePolicy softDeletePolicyEncode(SoftDeletePolicy from) {
Bucket.SoftDeletePolicy to = new Bucket.SoftDeletePolicy();
ifNonNull(
from.getRetentionDuration(), durationSecondsCodec::encode, to::setRetentionDurationSeconds);
return to;
}
private SoftDeletePolicy softDeletePolicyDecode(Bucket.SoftDeletePolicy from) {
SoftDeletePolicy.Builder to = SoftDeletePolicy.newBuilder();
ifNonNull(
from.getRetentionDurationSeconds(), durationSecondsCodec::decode, to::setRetentionDuration);
ifNonNull(from.getEffectiveTime(), dateTimeCodec::decode, to::setEffectiveTime);
return to.build();
}
private Bucket bucketInfoEncode(BucketInfo from) {
Bucket to = new Bucket();
ifNonNull(from.getProject(), projectNameCodec::encode, p -> to.set(PROJECT_ID_FIELD_NAME, p));
ifNonNull(from.getAcl(), toListOf(bucketAcl()::encode), to::setAcl);
ifNonNull(from.getCors(), toListOf(cors()::encode), to::setCors);
ifNonNull(from.getCreateTimeOffsetDateTime(), dateTimeCodec::encode, to::setTimeCreated);
ifNonNull(from.getDefaultAcl(), toListOf(objectAcl()::encode), to::setDefaultObjectAcl);
ifNonNull(from.getLocation(), to::setLocation);
ifNonNull(from.getLocationType(), to::setLocationType);
ifNonNull(from.getMetageneration(), to::setMetageneration);
ifNonNull(
from.getOwner(),
lift(this::entityEncode).andThen(o -> new Bucket.Owner().setEntity(o)),
to::setOwner);
ifNonNull(from.getRpo(), Rpo::toString, to::setRpo);
ifNonNull(from.getStorageClass(), StorageClass::toString, to::setStorageClass);
ifNonNull(from.getUpdateTimeOffsetDateTime(), dateTimeCodec::encode, to::setUpdated);
ifNonNull(from.versioningEnabled(), b -> new Versioning().setEnabled(b), to::setVersioning);
to.setEtag(from.getEtag());
to.setId(from.getGeneratedId());
to.setName(from.getName());
to.setSelfLink(from.getSelfLink());
ifNonNull(from.requesterPays(), b -> new Bucket.Billing().setRequesterPays(b), to::setBilling);
if (from.getIndexPage() != null || from.getNotFoundPage() != null) {
Website website = new Website();
website.setMainPageSuffix(from.getIndexPage());
website.setNotFoundPage(from.getNotFoundPage());
to.setWebsite(website);
}
// Do not use, #getLifecycleRules, it can not return null, which is important to our logic here
List lifecycleRules = from.lifecycleRules;
if (lifecycleRules != null) {
Lifecycle lifecycle = new Lifecycle();
if (lifecycleRules.isEmpty()) {
lifecycle.setRule(Collections.emptyList());
} else {
List rules = new ArrayList<>();
ifNonNull(lifecycleRules, r -> r.stream().map(lifecycleRule()::encode).forEach(rules::add));
if (!rules.isEmpty()) {
lifecycle.setRule(ImmutableList.copyOf(rules));
}
}
to.setLifecycle(lifecycle);
}
ifNonNull(from.getDefaultEventBasedHold(), to::setDefaultEventBasedHold);
ifNonNull(
from.getDefaultKmsKeyName(),
k -> new Encryption().setDefaultKmsKeyName(k),
to::setEncryption);
Map pbLabels = from.getLabels();
if (pbLabels != null && !Data.isNull(pbLabels)) {
pbLabels = Maps.newHashMapWithExpectedSize(from.getLabels().size());
for (Map.Entry entry : from.getLabels().entrySet()) {
pbLabels.put(entry.getKey(), firstNonNull(entry.getValue(), Data.nullOf(String.class)));
}
}
to.setLabels(pbLabels);
maybeEncodeRetentionPolicy(from, to);
ifNonNull(from.getIamConfiguration(), this::iamConfigEncode, to::setIamConfiguration);
ifNonNull(from.getAutoclass(), this::autoclassEncode, to::setAutoclass);
ifNonNull(from.getLogging(), this::loggingEncode, to::setLogging);
ifNonNull(
from.getCustomPlacementConfig(),
this::customPlacementConfigEncode,
to::setCustomPlacementConfig);
ifNonNull(from.getObjectRetention(), this::objectRetentionEncode, to::setObjectRetention);
ifNonNull(from.getSoftDeletePolicy(), this::softDeletePolicyEncode, to::setSoftDeletePolicy);
if (from.getSoftDeletePolicy() == null
&& from.getModifiedFields().contains(SOFT_DELETE_POLICY)) {
to.setSoftDeletePolicy(Data.nullOf(Bucket.SoftDeletePolicy.class));
}
ifNonNull(
from.getHierarchicalNamespace(),
this::hierarchicalNamespaceEncode,
to::setHierarchicalNamespace);
return to;
}
@SuppressWarnings("deprecation")
private BucketInfo bucketInfoDecode(com.google.api.services.storage.model.Bucket from) {
BucketInfo.Builder to = new BucketInfo.BuilderImpl(from.getName());
ifNonNull(
from.get(PROJECT_ID_FIELD_NAME),
lift(String.class::cast).andThen(projectNameCodec::decode),
to::setProject);
ifNonNull(from.getAcl(), toListOf(bucketAcl()::decode), to::setAcl);
ifNonNull(from.getCors(), toListOf(cors()::decode), to::setCors);
ifNonNull(from.getDefaultObjectAcl(), toListOf(objectAcl()::decode), to::setDefaultAcl);
ifNonNull(from.getEtag(), to::setEtag);
ifNonNull(from.getId(), to::setGeneratedId);
ifNonNull(from.getLocation(), to::setLocation);
ifNonNull(from.getLocationType(), to::setLocationType);
ifNonNull(from.getMetageneration(), to::setMetageneration);
ifNonNull(
from.getOwner(), lift(Bucket.Owner::getEntity).andThen(this::entityDecode), to::setOwner);
ifNonNull(from.getRpo(), Rpo::valueOf, to::setRpo);
ifNonNull(from.getSelfLink(), to::setSelfLink);
ifNonNull(from.getStorageClass(), StorageClass::valueOf, to::setStorageClass);
ifNonNull(from.getTimeCreated(), dateTimeCodec::decode, to::setCreateTimeOffsetDateTime);
ifNonNull(from.getUpdated(), dateTimeCodec::decode, to::setUpdateTimeOffsetDateTime);
ifNonNull(from.getVersioning(), Versioning::getEnabled, to::setVersioningEnabled);
ifNonNull(from.getWebsite(), Website::getMainPageSuffix, to::setIndexPage);
ifNonNull(from.getWebsite(), Website::getNotFoundPage, to::setNotFoundPage);
ifNonNull(
from.getLifecycle(),
lift(Lifecycle::getRule).andThen(toListOf(lifecycleRule()::decode)),
to::setLifecycleRules);
ifNonNull(from.getDefaultEventBasedHold(), to::setDefaultEventBasedHold);
ifNonNull(from.getLabels(), JsonConversions::replaceDataNullValuesWithNull, to::setLabels);
ifNonNull(from.getBilling(), Billing::getRequesterPays, to::setRequesterPays);
Encryption encryption = from.getEncryption();
if (encryption != null
&& encryption.getDefaultKmsKeyName() != null
&& !encryption.getDefaultKmsKeyName().isEmpty()) {
to.setDefaultKmsKeyName(encryption.getDefaultKmsKeyName());
}
maybeDecodeRetentionPolicy(from, to);
ifNonNull(from.getIamConfiguration(), this::iamConfigDecode, to::setIamConfiguration);
ifNonNull(from.getAutoclass(), this::autoclassDecode, to::setAutoclass);
ifNonNull(from.getLogging(), this::loggingDecode, to::setLogging);
ifNonNull(
from.getCustomPlacementConfig(),
this::customPlacementConfigDecode,
to::setCustomPlacementConfig);
ifNonNull(
from.getHierarchicalNamespace(),
this::hierarchicalNamespaceDecode,
to::setHierarchicalNamespace);
ifNonNull(from.getObjectRetention(), this::objectRetentionDecode, to::setObjectRetention);
ifNonNull(from.getSoftDeletePolicy(), this::softDeletePolicyDecode, to::setSoftDeletePolicy);
return to.build();
}
private Bucket.IamConfiguration iamConfigEncode(IamConfiguration from) {
Bucket.IamConfiguration to = new Bucket.IamConfiguration();
to.setUniformBucketLevelAccess(ublaEncode(from));
ifNonNull(
from.getPublicAccessPrevention(),
PublicAccessPrevention::getValue,
to::setPublicAccessPrevention);
return to;
}
private IamConfiguration iamConfigDecode(Bucket.IamConfiguration from) {
Bucket.IamConfiguration.UniformBucketLevelAccess ubla = from.getUniformBucketLevelAccess();
IamConfiguration.Builder to =
IamConfiguration.newBuilder().setIsUniformBucketLevelAccessEnabled(ubla.getEnabled());
ifNonNull(
ubla.getLockedTime(),
dateTimeCodec::decode,
to::setUniformBucketLevelAccessLockedTimeOffsetDateTime);
ifNonNull(
from.getPublicAccessPrevention(),
PublicAccessPrevention::parse,
to::setPublicAccessPrevention);
return to.build();
}
private Bucket.Autoclass autoclassEncode(Autoclass from) {
Bucket.Autoclass to = new Bucket.Autoclass();
ifNonNull(from.getEnabled(), to::setEnabled);
ifNonNull(from.getToggleTime(), dateTimeCodec::encode, to::setToggleTime);
ifNonNull(from.getTerminalStorageClass(), StorageClass::toString, to::setTerminalStorageClass);
ifNonNull(
from.getTerminalStorageClassUpdateTime(),
dateTimeCodec::encode,
to::setTerminalStorageClassUpdateTime);
return to;
}
private Autoclass autoclassDecode(Bucket.Autoclass from) {
Autoclass.Builder to = Autoclass.newBuilder();
to.setEnabled(from.getEnabled());
ifNonNull(from.getToggleTime(), dateTimeCodec::decode, to::setToggleTime);
ifNonNull(from.getTerminalStorageClass(), StorageClass::valueOf, to::setTerminalStorageClass);
ifNonNull(
from.getTerminalStorageClassUpdateTime(),
dateTimeCodec::decode,
to::setTerminalStorageClassUpdateTime);
return to.build();
}
private Bucket.ObjectRetention objectRetentionEncode(ObjectRetention from) {
Bucket.ObjectRetention to = new Bucket.ObjectRetention();
ifNonNull(from.getMode(), ObjectRetention.Mode::toString, to::setMode);
return to;
}
private ObjectRetention objectRetentionDecode(Bucket.ObjectRetention from) {
ObjectRetention.Builder to = ObjectRetention.newBuilder();
ifNonNull(from.getMode(), ObjectRetention.Mode::valueOf, to::setMode);
return to.build();
}
private UniformBucketLevelAccess ublaEncode(IamConfiguration from) {
UniformBucketLevelAccess to = new UniformBucketLevelAccess();
to.setEnabled(from.isUniformBucketLevelAccessEnabled());
ifNonNull(
from.getUniformBucketLevelAccessLockedTimeOffsetDateTime(),
dateTimeCodec::encode,
to::setLockedTime);
return to;
}
private Rule lifecycleRuleEncode(LifecycleRule from) {
Rule to = new Rule();
to.setAction(ruleActionEncode(from.getAction()));
to.setCondition(ruleConditionEncode(from.getCondition()));
return to;
}
private Condition ruleConditionEncode(LifecycleCondition from) {
Function truncatingDateFunction =
lift(dateTimeCodec::encode)
// truncate the date time to the date, and strip any tz drift
.andThen(dt -> new DateTime(true, dt.getValue(), 0));
Condition to =
new Condition()
.setAge(from.getAge())
.setIsLive(from.getIsLive())
.setNumNewerVersions(from.getNumberOfNewerVersions())
.setDaysSinceNoncurrentTime(from.getDaysSinceNoncurrentTime())
.setDaysSinceCustomTime(from.getDaysSinceCustomTime());
ifNonNull(from.getCreatedBeforeOffsetDateTime(), truncatingDateFunction, to::setCreatedBefore);
ifNonNull(
from.getNoncurrentTimeBeforeOffsetDateTime(),
truncatingDateFunction,
to::setNoncurrentTimeBefore);
ifNonNull(
from.getCustomTimeBeforeOffsetDateTime(), truncatingDateFunction, to::setCustomTimeBefore);
ifNonNull(
from.getMatchesStorageClass(), toListOf(Object::toString), to::setMatchesStorageClass);
ifNonNull(from.getMatchesPrefix(), to::setMatchesPrefix);
ifNonNull(from.getMatchesSuffix(), to::setMatchesSuffix);
return to;
}
private LifecycleCondition ruleConditionDecode(Condition condition) {
if (condition == null) {
return LifecycleCondition.newBuilder().build();
}
LifecycleCondition.Builder conditionBuilder =
LifecycleCondition.newBuilder()
.setAge(condition.getAge())
.setCreatedBeforeOffsetDateTime(
nullableDateTimeCodec.decode(condition.getCreatedBefore()))
.setIsLive(condition.getIsLive())
.setNumberOfNewerVersions(condition.getNumNewerVersions())
.setDaysSinceNoncurrentTime(condition.getDaysSinceNoncurrentTime())
.setNoncurrentTimeBeforeOffsetDateTime(
nullableDateTimeCodec.decode(condition.getNoncurrentTimeBefore()))
.setCustomTimeBeforeOffsetDateTime(
nullableDateTimeCodec.decode(condition.getCustomTimeBefore()))
.setDaysSinceCustomTime(condition.getDaysSinceCustomTime());
ifNonNull(
condition.getMatchesStorageClass(),
toListOf(StorageClass::valueOf),
conditionBuilder::setMatchesStorageClass);
ifNonNull(condition.getMatchesPrefix(), conditionBuilder::setMatchesPrefix);
ifNonNull(condition.getMatchesSuffix(), conditionBuilder::setMatchesSuffix);
return conditionBuilder.build();
}
private Action ruleActionEncode(LifecycleAction from) {
Action to = new Action().setType(from.getActionType());
if (from.getActionType().equals(SetStorageClassLifecycleAction.TYPE)) {
to.setStorageClass(((SetStorageClassLifecycleAction) from).getStorageClass().toString());
}
return to;
}
private LifecycleRule lifecycleRuleDecode(Rule from) {
LifecycleAction lifecycleAction;
Rule.Action action = from.getAction();
switch (action.getType()) {
case DeleteLifecycleAction.TYPE:
lifecycleAction = LifecycleAction.newDeleteAction();
break;
case SetStorageClassLifecycleAction.TYPE:
lifecycleAction =
LifecycleAction.newSetStorageClassAction(
StorageClass.valueOf(action.getStorageClass()));
break;
case AbortIncompleteMPUAction.TYPE:
lifecycleAction = LifecycleAction.newAbortIncompleteMPUploadAction();
break;
default:
BucketInfo.log.warning(
"The lifecycle action "
+ action.getType()
+ " is not supported by this version of the library. "
+ "Attempting to update with this rule may cause errors. Please "
+ "update to the latest version of google-cloud-storage.");
lifecycleAction = LifecycleAction.newLifecycleAction("Unknown action");
}
LifecycleCondition lifecycleCondition = ruleConditionDecode(from.getCondition());
return new LifecycleRule(lifecycleAction, lifecycleCondition);
}
private Bucket.Logging loggingEncode(Logging from) {
Bucket.Logging to;
if (from.getLogBucket() != null || from.getLogObjectPrefix() != null) {
to = new Bucket.Logging();
ifNonNull(from.getLogBucket(), to::setLogBucket);
ifNonNull(from.getLogObjectPrefix(), to::setLogObjectPrefix);
} else {
to = Data.nullOf(Bucket.Logging.class);
}
return to;
}
private Logging loggingDecode(Bucket.Logging from) {
return Logging.newBuilder()
.setLogBucket(from.getLogBucket())
.setLogObjectPrefix(from.getLogObjectPrefix())
.build();
}
private Bucket.Cors corsEncode(Cors from) {
Bucket.Cors to = new Bucket.Cors();
to.setMaxAgeSeconds(from.getMaxAgeSeconds());
to.setResponseHeader(from.getResponseHeaders());
ifNonNull(from.getMethods(), toListOf(Object::toString), to::setMethod);
ifNonNull(from.getOrigins(), toListOf(Object::toString), to::setOrigin);
return to;
}
private Cors corsDecode(Bucket.Cors from) {
Cors.Builder to = Cors.newBuilder().setMaxAgeSeconds(from.getMaxAgeSeconds());
ifNonNull(
from.getMethod(),
m ->
m.stream()
.map(String::toUpperCase)
.map(HttpMethod::valueOf)
.collect(ImmutableList.toImmutableList()),
to::setMethods);
ifNonNull(from.getOrigin(), toListOf(Origin::of), to::setOrigins);
to.setResponseHeaders(from.getResponseHeader());
return to.build();
}
private com.google.api.services.storage.model.ServiceAccount serviceAccountEncode(
ServiceAccount from) {
return new com.google.api.services.storage.model.ServiceAccount()
.setEmailAddress(from.getEmail());
}
private ServiceAccount serviceAccountDecode(
com.google.api.services.storage.model.ServiceAccount from) {
return ServiceAccount.of(from.getEmailAddress());
}
private com.google.api.services.storage.model.HmacKey hmacKeyEncode(HmacKey from) {
com.google.api.services.storage.model.HmacKey to =
new com.google.api.services.storage.model.HmacKey();
to.setSecret(from.getSecretKey());
ifNonNull(from.getMetadata(), this::hmacKeyMetadataEncode, to::setMetadata);
return to;
}
private HmacKey hmacKeyDecode(com.google.api.services.storage.model.HmacKey from) {
return HmacKey.newBuilder(from.getSecret())
.setMetadata(hmacKeyMetadataDecode(from.getMetadata()))
.build();
}
private com.google.api.services.storage.model.HmacKeyMetadata hmacKeyMetadataEncode(
HmacKeyMetadata from) {
com.google.api.services.storage.model.HmacKeyMetadata to =
new com.google.api.services.storage.model.HmacKeyMetadata();
to.setAccessId(from.getAccessId());
to.setEtag(from.getEtag());
to.setId(from.getId());
to.setProjectId(from.getProjectId());
ifNonNull(from.getServiceAccount(), ServiceAccount::getEmail, to::setServiceAccountEmail);
ifNonNull(from.getState(), Enum::name, to::setState);
ifNonNull(from.getCreateTimeOffsetDateTime(), dateTimeCodec::encode, to::setTimeCreated);
ifNonNull(from.getUpdateTimeOffsetDateTime(), dateTimeCodec::encode, to::setUpdated);
return to;
}
private HmacKeyMetadata hmacKeyMetadataDecode(
com.google.api.services.storage.model.HmacKeyMetadata from) {
return HmacKeyMetadata.newBuilder(ServiceAccount.of(from.getServiceAccountEmail()))
.setAccessId(from.getAccessId())
.setCreateTimeOffsetDateTime(dateTimeCodec.decode(from.getTimeCreated()))
.setEtag(from.getEtag())
.setId(from.getId())
.setProjectId(from.getProjectId())
.setState(HmacKeyState.valueOf(from.getState()))
.setUpdateTimeOffsetDateTime(dateTimeCodec.decode(from.getUpdated()))
.build();
}
private String entityEncode(Entity from) {
if (from instanceof RawEntity) {
return from.getValue();
} else if (from instanceof User) {
switch (from.getValue()) {
case User.ALL_AUTHENTICATED_USERS:
return User.ALL_AUTHENTICATED_USERS;
case User.ALL_USERS:
return User.ALL_USERS;
default:
break;
}
}
// intentionally not an else so that if the default is hit above it will fall through to here
return from.getType().name().toLowerCase() + "-" + from.getValue();
}
private Entity entityDecode(String from) {
if (from.startsWith("user-")) {
return new User(from.substring(5));
}
if (from.equals(User.ALL_USERS)) {
return User.ofAllUsers();
}
if (from.equals(User.ALL_AUTHENTICATED_USERS)) {
return User.ofAllAuthenticatedUsers();
}
if (from.startsWith("group-")) {
return new Group(from.substring(6));
}
if (from.startsWith("domain-")) {
return new Domain(from.substring(7));
}
if (from.startsWith("project-")) {
int idx = from.indexOf('-', 8);
String team = from.substring(8, idx);
String projectId = from.substring(idx + 1);
return new Project(Project.ProjectRole.valueOf(team.toUpperCase()), projectId);
}
return new RawEntity(from);
}
private Acl objectAclDecode(ObjectAccessControl from) {
Role role = Role.valueOf(from.getRole());
Entity entity = entityDecode(from.getEntity());
return Acl.newBuilder(entity, role).setEtag(from.getEtag()).setId(from.getId()).build();
}
private Acl bucketAclDecode(BucketAccessControl from) {
Role role = Role.valueOf(from.getRole());
Entity entity = entityDecode(from.getEntity());
return Acl.newBuilder(entity, role).setEtag(from.getEtag()).setId(from.getId()).build();
}
private BucketAccessControl bucketAclEncode(Acl from) {
return new BucketAccessControl()
.setEntity(from.getEntity().toString())
.setRole(from.getRole().toString())
.setId(from.getId())
.setEtag(from.getEtag());
}
private ObjectAccessControl objectAclEncode(Acl from) {
return new ObjectAccessControl()
.setEntity(entityEncode(from.getEntity()))
.setRole(from.getRole().name())
.setId(from.getId())
.setEtag(from.getEtag());
}
private com.google.api.services.storage.model.Notification notificationEncode(
NotificationInfo from) {
com.google.api.services.storage.model.Notification to =
new com.google.api.services.storage.model.Notification();
to.setEtag(from.getEtag());
to.setSelfLink(from.getSelfLink());
to.setTopic(from.getTopic());
ifNonNull(from.getBucket(), b -> to.set(NOTIFICATION_BUCKET_FIELD_NAME, b));
ifNonNull(from.getNotificationId(), to::setId);
ifNonNull(from.getCustomAttributes(), to::setCustomAttributes);
ifNonNull(from.getObjectNamePrefix(), to::setObjectNamePrefix);
List eventTypes = from.getEventTypes();
if (eventTypes != null && eventTypes.size() > 0) {
List eventTypesPb = new ArrayList<>();
for (EventType eventType : eventTypes) {
eventTypesPb.add(eventType.toString());
}
to.setEventTypes(eventTypesPb);
}
PayloadFormat payloadFormat = from.getPayloadFormat();
if (payloadFormat != null) {
to.setPayloadFormat(payloadFormat.toString());
} else {
to.setPayloadFormat(PayloadFormat.NONE.toString());
}
return to;
}
private Bucket.HierarchicalNamespace hierarchicalNamespaceEncode(
BucketInfo.HierarchicalNamespace from) {
Bucket.HierarchicalNamespace to = new Bucket.HierarchicalNamespace();
ifNonNull(from.getEnabled(), to::setEnabled);
return to;
}
private BucketInfo.HierarchicalNamespace hierarchicalNamespaceDecode(
Bucket.HierarchicalNamespace from) {
BucketInfo.HierarchicalNamespace.Builder to = BucketInfo.HierarchicalNamespace.newBuilder();
to.setEnabled(from.getEnabled());
return to.build();
}
private NotificationInfo notificationDecode(
com.google.api.services.storage.model.Notification from) {
NotificationInfo.Builder builder = new NotificationInfo.BuilderImpl(from.getTopic());
ifNonNull(from.get(NOTIFICATION_BUCKET_FIELD_NAME), String.class::cast, builder::setBucket);
ifNonNull(from.getId(), builder::setNotificationId);
ifNonNull(from.getEtag(), builder::setEtag);
ifNonNull(from.getCustomAttributes(), builder::setCustomAttributes);
ifNonNull(from.getSelfLink(), builder::setSelfLink);
ifNonNull(from.getObjectNamePrefix(), builder::setObjectNamePrefix);
ifNonNull(from.getPayloadFormat(), PayloadFormat::valueOf, builder::setPayloadFormat);
if (from.getEventTypes() != null) {
List eventTypesPb = from.getEventTypes();
EventType[] eventTypes = new EventType[eventTypesPb.size()];
for (int index = 0; index < eventTypesPb.size(); index++) {
eventTypes[index] = EventType.valueOf(eventTypesPb.get(index));
}
builder.setEventTypes(eventTypes);
}
return builder.build();
}
private com.google.api.services.storage.model.Policy policyEncode(Policy from) {
com.google.api.services.storage.model.Policy to =
new com.google.api.services.storage.model.Policy();
ifNonNull(from.getEtag(), to::setEtag);
ifNonNull(from.getVersion(), to::setVersion);
if (from.getBindingsList() != null) {
ImmutableList bindings =
from.getBindingsList().stream()
.map(bindingCodec::encode)
.collect(ImmutableList.toImmutableList());
to.setBindings(bindings);
}
return to;
}
private Policy policyDecode(com.google.api.services.storage.model.Policy from) {
Policy.Builder to = Policy.newBuilder();
String etag = from.getEtag();
if (etag != null && !etag.isEmpty()) {
to.setEtag(etag);
}
to.setVersion(from.getVersion());
List bindings = from.getBindings();
if (bindings != null && !bindings.isEmpty()) {
to.setBindings(
bindings.stream().map(bindingCodec::decode).collect(ImmutableList.toImmutableList()));
}
return to.build();
}
private com.google.api.services.storage.model.Policy.Bindings bindingEncode(Binding from) {
com.google.api.services.storage.model.Policy.Bindings to =
new com.google.api.services.storage.model.Policy.Bindings();
ifNonNull(from.getRole(), to::setRole);
ifNonNull(from.getMembers(), to::setMembers);
ifNonNull(from.getCondition(), iamConditionCodec::encode, to::setCondition);
return to;
}
private Binding bindingDecode(com.google.api.services.storage.model.Policy.Bindings from) {
Binding.Builder to = Binding.newBuilder();
ifNonNull(from.getRole(), to::setRole);
ifNonNull(from.getMembers(), to::setMembers);
ifNonNull(from.getCondition(), iamConditionCodec::decode, to::setCondition);
return to.build();
}
private com.google.api.services.storage.model.Expr conditionEncode(
com.google.cloud.Condition from) {
com.google.api.services.storage.model.Expr to =
new com.google.api.services.storage.model.Expr();
ifNonNull(from.getExpression(), to::setExpression);
ifNonNull(from.getTitle(), to::setTitle);
ifNonNull(from.getDescription(), to::setDescription);
// apiary doesn't have a "location" field like grpc does
return to;
}
private com.google.cloud.Condition conditionDecode(
com.google.api.services.storage.model.Expr from) {
com.google.cloud.Condition.Builder to = com.google.cloud.Condition.newBuilder();
ifNonNull(from.getExpression(), to::setExpression);
ifNonNull(from.getTitle(), to::setTitle);
ifNonNull(from.getDescription(), to::setDescription);
return to.build();
}
private Bucket.CustomPlacementConfig customPlacementConfigEncode(CustomPlacementConfig from) {
Bucket.CustomPlacementConfig to = null;
if (from.getDataLocations() != null) {
to = new Bucket.CustomPlacementConfig();
to.setDataLocations(from.getDataLocations());
}
return to;
}
private CustomPlacementConfig customPlacementConfigDecode(Bucket.CustomPlacementConfig from) {
return CustomPlacementConfig.newBuilder().setDataLocations(from.getDataLocations()).build();
}
private static void maybeEncodeRetentionPolicy(BucketInfo from, Bucket to) {
if (from.getRetentionPeriodDuration() != null
|| from.retentionPolicyIsLocked() != null
|| from.getRetentionEffectiveTimeOffsetDateTime() != null) {
RetentionPolicy retentionPolicy = new RetentionPolicy();
ifNonNull(
from.getRetentionPeriodDuration(),
durationSecondsCodec::encode,
retentionPolicy::setRetentionPeriod);
ifNonNull(from.retentionPolicyIsLocked(), retentionPolicy::setIsLocked);
ifNonNull(
from.getRetentionEffectiveTimeOffsetDateTime(),
dateTimeCodec::encode,
retentionPolicy::setEffectiveTime);
to.setRetentionPolicy(retentionPolicy);
} else {
to.setRetentionPolicy(Data.nullOf(Bucket.RetentionPolicy.class));
}
}
private static void maybeDecodeRetentionPolicy(Bucket from, BucketInfo.Builder to) {
RetentionPolicy retentionPolicy = from.getRetentionPolicy();
if (retentionPolicy != null && retentionPolicy.getEffectiveTime() != null) {
to.setRetentionEffectiveTimeOffsetDateTime(
dateTimeCodec.decode(retentionPolicy.getEffectiveTime()));
}
if (retentionPolicy != null) {
ifNonNull(retentionPolicy.getIsLocked(), to::setRetentionPolicyIsLocked);
ifNonNull(
retentionPolicy.getRetentionPeriod(),
durationSecondsCodec::decode,
to::setRetentionPeriodDuration);
}
}
private static Map replaceDataNullValuesWithNull(Map labels) {
boolean anyDataNull = labels.values().stream().anyMatch(Data::isNull);
if (anyDataNull) {
// If we received any Data null values, replace them with null before setting.
// Explicitly use a HashMap as it allows null values.
Map tmp = Maps.newHashMapWithExpectedSize(labels.size());
for (Entry e : labels.entrySet()) {
String k = e.getKey();
String v = e.getValue();
tmp.put(k, Data.isNull(v) ? null : v);
}
return Collections.unmodifiableMap(tmp);
} else {
return labels;
}
}
/**
* Several properties are translating lists of one type to another. This convenience method allows
* specifying a mapping function and composing as part of an {@code #isNonNull} definition.
*
* Apiary specific utility method to convert from one list to another for specific Function
*/
private static Function, List> toListOf(Function f) {
// various data level methods in the apiary model are hostile to ImmutableList, as it does not
// provide a public default no args constructor. Instead, apiary uses ArrayList for all internal
// representations of JSON Arrays.
return l -> {
if (l == null) {
return ImmutableList.of();
}
return l.stream().filter(Objects::nonNull).map(f).collect(Collectors.toList());
};
}
}