• Home
• com.google.apis
• google-api-services-secretmanager
• v1-rev20240924-2.0.0
• source code
• SecretVersion.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.google.api.services.secretmanager.v1.model.SecretVersion Maven / Gradle / Ivy

/*
 * 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.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.secretmanager.v1.model;

/**
 * A secret version resource in the Secret Manager API.
 *
 * 
 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 Secret Manager API. For a detailed explanation see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class SecretVersion extends com.google.api.client.json.GenericJson {

  /**
   * Output only. True if payload checksum specified in SecretPayload object has been received by
   * SecretManagerService on SecretManagerService.AddSecretVersion.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean clientSpecifiedPayloadChecksum;

  /**
   * Output only. The time at which the SecretVersion was created.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String createTime;

  /**
   * Output only. The customer-managed encryption status of the SecretVersion. Only populated if
   * customer-managed encryption is used and Secret is a regionalized secret.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private CustomerManagedEncryptionStatus customerManagedEncryption;

  /**
   * Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String destroyTime;

  /**
   * Output only. Etag of the currently stored SecretVersion.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String etag;

  /**
   * Output only. The resource name of the SecretVersion in the format `projects/secrets/versions`.
   * SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the
   * secret.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * The replication status of the SecretVersion.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private ReplicationStatus replicationStatus;

  /**
   * Optional. Output only. Scheduled destroy time for secret version. This is a part of the Delayed
   * secret version destroy feature. For a Secret with a valid version destroy TTL, when a secert
   * version is destroyed, version is moved to disabled state and it is scheduled for destruction
   * Version is destroyed only after the scheduled_destroy_time.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String scheduledDestroyTime;

  /**
   * Output only. The current state of the SecretVersion.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String state;

  /**
   * Output only. True if payload checksum specified in SecretPayload object has been received by
   * SecretManagerService on SecretManagerService.AddSecretVersion.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getClientSpecifiedPayloadChecksum() {
    return clientSpecifiedPayloadChecksum;
  }

  /**
   * Output only. True if payload checksum specified in SecretPayload object has been received by
   * SecretManagerService on SecretManagerService.AddSecretVersion.
   * @param clientSpecifiedPayloadChecksum clientSpecifiedPayloadChecksum or {@code null} for none
   */
  public SecretVersion setClientSpecifiedPayloadChecksum(java.lang.Boolean clientSpecifiedPayloadChecksum) {
    this.clientSpecifiedPayloadChecksum = clientSpecifiedPayloadChecksum;
    return this;
  }

  /**
   * Output only. The time at which the SecretVersion was created.
   * @return value or {@code null} for none
   */
  public String getCreateTime() {
    return createTime;
  }

  /**
   * Output only. The time at which the SecretVersion was created.
   * @param createTime createTime or {@code null} for none
   */
  public SecretVersion setCreateTime(String createTime) {
    this.createTime = createTime;
    return this;
  }

  /**
   * Output only. The customer-managed encryption status of the SecretVersion. Only populated if
   * customer-managed encryption is used and Secret is a regionalized secret.
   * @return value or {@code null} for none
   */
  public CustomerManagedEncryptionStatus getCustomerManagedEncryption() {
    return customerManagedEncryption;
  }

  /**
   * Output only. The customer-managed encryption status of the SecretVersion. Only populated if
   * customer-managed encryption is used and Secret is a regionalized secret.
   * @param customerManagedEncryption customerManagedEncryption or {@code null} for none
   */
  public SecretVersion setCustomerManagedEncryption(CustomerManagedEncryptionStatus customerManagedEncryption) {
    this.customerManagedEncryption = customerManagedEncryption;
    return this;
  }

  /**
   * Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
   * @return value or {@code null} for none
   */
  public String getDestroyTime() {
    return destroyTime;
  }

  /**
   * Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
   * @param destroyTime destroyTime or {@code null} for none
   */
  public SecretVersion setDestroyTime(String destroyTime) {
    this.destroyTime = destroyTime;
    return this;
  }

  /**
   * Output only. Etag of the currently stored SecretVersion.
   * @return value or {@code null} for none
   */
  public java.lang.String getEtag() {
    return etag;
  }

  /**
   * Output only. Etag of the currently stored SecretVersion.
   * @param etag etag or {@code null} for none
   */
  public SecretVersion setEtag(java.lang.String etag) {
    this.etag = etag;
    return this;
  }

  /**
   * Output only. The resource name of the SecretVersion in the format `projects/secrets/versions`.
   * SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the
   * secret.
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * Output only. The resource name of the SecretVersion in the format `projects/secrets/versions`.
   * SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the
   * secret.
   * @param name name or {@code null} for none
   */
  public SecretVersion setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  /**
   * The replication status of the SecretVersion.
   * @return value or {@code null} for none
   */
  public ReplicationStatus getReplicationStatus() {
    return replicationStatus;
  }

  /**
   * The replication status of the SecretVersion.
   * @param replicationStatus replicationStatus or {@code null} for none
   */
  public SecretVersion setReplicationStatus(ReplicationStatus replicationStatus) {
    this.replicationStatus = replicationStatus;
    return this;
  }

  /**
   * Optional. Output only. Scheduled destroy time for secret version. This is a part of the Delayed
   * secret version destroy feature. For a Secret with a valid version destroy TTL, when a secert
   * version is destroyed, version is moved to disabled state and it is scheduled for destruction
   * Version is destroyed only after the scheduled_destroy_time.
   * @return value or {@code null} for none
   */
  public String getScheduledDestroyTime() {
    return scheduledDestroyTime;
  }

  /**
   * Optional. Output only. Scheduled destroy time for secret version. This is a part of the Delayed
   * secret version destroy feature. For a Secret with a valid version destroy TTL, when a secert
   * version is destroyed, version is moved to disabled state and it is scheduled for destruction
   * Version is destroyed only after the scheduled_destroy_time.
   * @param scheduledDestroyTime scheduledDestroyTime or {@code null} for none
   */
  public SecretVersion setScheduledDestroyTime(String scheduledDestroyTime) {
    this.scheduledDestroyTime = scheduledDestroyTime;
    return this;
  }

  /**
   * Output only. The current state of the SecretVersion.
   * @return value or {@code null} for none
   */
  public java.lang.String getState() {
    return state;
  }

  /**
   * Output only. The current state of the SecretVersion.
   * @param state state or {@code null} for none
   */
  public SecretVersion setState(java.lang.String state) {
    this.state = state;
    return this;
  }

  @Override
  public SecretVersion set(String fieldName, Object value) {
    return (SecretVersion) super.set(fieldName, value);
  }

  @Override
  public SecretVersion clone() {
    return (SecretVersion) super.clone();
  }

}