com.google.api.services.containeranalysis.v1.model.BuildOccurrence Maven / Gradle / Ivy

Go to download
/*
 * 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.containeranalysis.v1.model;

/**
 * Details of a build occurrence.
 *
 *  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 Container Analysis 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 BuildOccurrence extends com.google.api.client.json.GenericJson {

  /**
   * In-Toto Slsa Provenance V1 represents a slsa provenance meeting the slsa spec, wrapped in an
   * in-toto statement. This allows for direct jsonification of a to-spec in-toto slsa statement
   * with a to-spec slsa provenance.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private InTotoSlsaProvenanceV1 inTotoSlsaProvenanceV1;

  /**
   * Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as
   * defined in spec.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private InTotoProvenance intotoProvenance;

  /**
   * In-toto Statement representation as defined in spec. The intoto_statement can contain any type
   * of provenance. The serialized payload of the statement can be stored and signed in the
   * Occurrence's envelope.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private InTotoStatement intotoStatement;

  /**
   * The actual provenance for the build.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private BuildProvenance provenance;

  /**
   * Serialized JSON representation of the provenance, used in generating the build signature in the
   * corresponding build note. After verifying the signature, `provenance_bytes` can be unmarshalled
   * and compared to the provenance to confirm that it is unchanged. A base64-encoded string
   * representation of the provenance bytes is used for the signature in order to interoperate with
   * openssl which expects this format for signature verification. The serialized form is captured
   * both to avoid ambiguity in how the provenance is marshalled to json as well to prevent
   * incompatibilities with future changes.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String provenanceBytes;

  /**
   * In-Toto Slsa Provenance V1 represents a slsa provenance meeting the slsa spec, wrapped in an
   * in-toto statement. This allows for direct jsonification of a to-spec in-toto slsa statement
   * with a to-spec slsa provenance.
   * @return value or {@code null} for none
   */
  public InTotoSlsaProvenanceV1 getInTotoSlsaProvenanceV1() {
    return inTotoSlsaProvenanceV1;
  }

  /**
   * In-Toto Slsa Provenance V1 represents a slsa provenance meeting the slsa spec, wrapped in an
   * in-toto statement. This allows for direct jsonification of a to-spec in-toto slsa statement
   * with a to-spec slsa provenance.
   * @param inTotoSlsaProvenanceV1 inTotoSlsaProvenanceV1 or {@code null} for none
   */
  public BuildOccurrence setInTotoSlsaProvenanceV1(InTotoSlsaProvenanceV1 inTotoSlsaProvenanceV1) {
    this.inTotoSlsaProvenanceV1 = inTotoSlsaProvenanceV1;
    return this;
  }

  /**
   * Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as
   * defined in spec.
   * @return value or {@code null} for none
   */
  public InTotoProvenance getIntotoProvenance() {
    return intotoProvenance;
  }

  /**
   * Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as
   * defined in spec.
   * @param intotoProvenance intotoProvenance or {@code null} for none
   */
  public BuildOccurrence setIntotoProvenance(InTotoProvenance intotoProvenance) {
    this.intotoProvenance = intotoProvenance;
    return this;
  }

  /**
   * In-toto Statement representation as defined in spec. The intoto_statement can contain any type
   * of provenance. The serialized payload of the statement can be stored and signed in the
   * Occurrence's envelope.
   * @return value or {@code null} for none
   */
  public InTotoStatement getIntotoStatement() {
    return intotoStatement;
  }

  /**
   * In-toto Statement representation as defined in spec. The intoto_statement can contain any type
   * of provenance. The serialized payload of the statement can be stored and signed in the
   * Occurrence's envelope.
   * @param intotoStatement intotoStatement or {@code null} for none
   */
  public BuildOccurrence setIntotoStatement(InTotoStatement intotoStatement) {
    this.intotoStatement = intotoStatement;
    return this;
  }

  /**
   * The actual provenance for the build.
   * @return value or {@code null} for none
   */
  public BuildProvenance getProvenance() {
    return provenance;
  }

  /**
   * The actual provenance for the build.
   * @param provenance provenance or {@code null} for none
   */
  public BuildOccurrence setProvenance(BuildProvenance provenance) {
    this.provenance = provenance;
    return this;
  }

  /**
   * Serialized JSON representation of the provenance, used in generating the build signature in the
   * corresponding build note. After verifying the signature, `provenance_bytes` can be unmarshalled
   * and compared to the provenance to confirm that it is unchanged. A base64-encoded string
   * representation of the provenance bytes is used for the signature in order to interoperate with
   * openssl which expects this format for signature verification. The serialized form is captured
   * both to avoid ambiguity in how the provenance is marshalled to json as well to prevent
   * incompatibilities with future changes.
   * @return value or {@code null} for none
   */
  public java.lang.String getProvenanceBytes() {
    return provenanceBytes;
  }

  /**
   * Serialized JSON representation of the provenance, used in generating the build signature in the
   * corresponding build note. After verifying the signature, `provenance_bytes` can be unmarshalled
   * and compared to the provenance to confirm that it is unchanged. A base64-encoded string
   * representation of the provenance bytes is used for the signature in order to interoperate with
   * openssl which expects this format for signature verification. The serialized form is captured
   * both to avoid ambiguity in how the provenance is marshalled to json as well to prevent
   * incompatibilities with future changes.
   * @param provenanceBytes provenanceBytes or {@code null} for none
   */
  public BuildOccurrence setProvenanceBytes(java.lang.String provenanceBytes) {
    this.provenanceBytes = provenanceBytes;
    return this;
  }

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

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

}