com.google.api.services.run.v1.model.SecretKeySelector Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-run Show documentation
There is a newer version: v2-rev20241213-2.0.0
Show newest version
/*
 * 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.run.v1.model;

/**
 * SecretKeySelector selects a key of a Secret.
 *
 *  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 Cloud Run Admin 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 SecretKeySelector extends com.google.api.client.json.GenericJson {

  /**
   * Required. A Cloud Secret Manager secret version. Must be 'latest' for the latest version or an
   * integer for a specific version. The key of the secret to select from. Must be a valid secret
   * key.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String key;

  /**
   * This field should not be used directly as it is meant to be inlined directly into the message.
   * Use the "name" field instead.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private LocalObjectReference localObjectReference;

  /**
   * The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the
   * same project. If the secret is in another project, you must define an alias. An alias
   * definition has the form: :projects//secrets/. If multiple alias definitions are needed, they
   * must be separated by commas. The alias definitions must be set on the
   * run.googleapis.com/secrets annotation. The name of the secret in the pod's namespace to select
   * from.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * Specify whether the Secret or its key must be defined.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean optional;

  /**
   * Required. A Cloud Secret Manager secret version. Must be 'latest' for the latest version or an
   * integer for a specific version. The key of the secret to select from. Must be a valid secret
   * key.
   * @return value or {@code null} for none
   */
  public java.lang.String getKey() {
    return key;
  }

  /**
   * Required. A Cloud Secret Manager secret version. Must be 'latest' for the latest version or an
   * integer for a specific version. The key of the secret to select from. Must be a valid secret
   * key.
   * @param key key or {@code null} for none
   */
  public SecretKeySelector setKey(java.lang.String key) {
    this.key = key;
    return this;
  }

  /**
   * This field should not be used directly as it is meant to be inlined directly into the message.
   * Use the "name" field instead.
   * @return value or {@code null} for none
   */
  public LocalObjectReference getLocalObjectReference() {
    return localObjectReference;
  }

  /**
   * This field should not be used directly as it is meant to be inlined directly into the message.
   * Use the "name" field instead.
   * @param localObjectReference localObjectReference or {@code null} for none
   */
  public SecretKeySelector setLocalObjectReference(LocalObjectReference localObjectReference) {
    this.localObjectReference = localObjectReference;
    return this;
  }

  /**
   * The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the
   * same project. If the secret is in another project, you must define an alias. An alias
   * definition has the form: :projects//secrets/. If multiple alias definitions are needed, they
   * must be separated by commas. The alias definitions must be set on the
   * run.googleapis.com/secrets annotation. The name of the secret in the pod's namespace to select
   * from.
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the
   * same project. If the secret is in another project, you must define an alias. An alias
   * definition has the form: :projects//secrets/. If multiple alias definitions are needed, they
   * must be separated by commas. The alias definitions must be set on the
   * run.googleapis.com/secrets annotation. The name of the secret in the pod's namespace to select
   * from.
   * @param name name or {@code null} for none
   */
  public SecretKeySelector setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  /**
   * Specify whether the Secret or its key must be defined.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getOptional() {
    return optional;
  }

  /**
   * Specify whether the Secret or its key must be defined.
   * @param optional optional or {@code null} for none
   */
  public SecretKeySelector setOptional(java.lang.Boolean optional) {
    this.optional = optional;
    return this;
  }

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

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

}