com.google.api.services.dlp.v2beta1.model.GooglePrivacyDlpV2beta1Key Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-dlp Show documentation
There is a newer version: v2-rev20241215-2.0.0
Show newest version
/*
 * Copyright 2010 Google Inc.
 *
 * 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/google/apis-client-generator/
 * (build: 2017-11-07 19:12:12 UTC)
 * on 2018-01-18 at 22:50:57 UTC 
 * Modify at your own risk.
 */

package com.google.api.services.dlp.v2beta1.model;

/**
 * A unique identifier for a Datastore entity. If a key's partition ID or any of its path kinds or
 * names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is
 * forbidden in certain documented contexts.
 *
 *  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 DLP 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 GooglePrivacyDlpV2beta1Key extends com.google.api.client.json.GenericJson {

  /**
   * Entities are partitioned into subsets, currently identified by a project ID and namespace ID.
   * Queries are scoped to a single partition.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GooglePrivacyDlpV2beta1PartitionId partitionId;

  /**
   * The entity path. An entity path consists of one or more elements composed of a kind and a
   * string or numerical identifier, which identify entities. The first element identifies a _root
   * entity_, the second element identifies a _child_ of the root entity, the third element
   * identifies a child of the second entity, and so forth. The entities identified by all prefixes
   * of the path are called the element's _ancestors_.
   *
   * A path can never be empty, and a path can have at most 100 elements.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List path;

  /**
   * Entities are partitioned into subsets, currently identified by a project ID and namespace ID.
   * Queries are scoped to a single partition.
   * @return value or {@code null} for none
   */
  public GooglePrivacyDlpV2beta1PartitionId getPartitionId() {
    return partitionId;
  }

  /**
   * Entities are partitioned into subsets, currently identified by a project ID and namespace ID.
   * Queries are scoped to a single partition.
   * @param partitionId partitionId or {@code null} for none
   */
  public GooglePrivacyDlpV2beta1Key setPartitionId(GooglePrivacyDlpV2beta1PartitionId partitionId) {
    this.partitionId = partitionId;
    return this;
  }

  /**
   * The entity path. An entity path consists of one or more elements composed of a kind and a
   * string or numerical identifier, which identify entities. The first element identifies a _root
   * entity_, the second element identifies a _child_ of the root entity, the third element
   * identifies a child of the second entity, and so forth. The entities identified by all prefixes
   * of the path are called the element's _ancestors_.
   *
   * A path can never be empty, and a path can have at most 100 elements.
   * @return value or {@code null} for none
   */
  public java.util.List getPath() {
    return path;
  }

  /**
   * The entity path. An entity path consists of one or more elements composed of a kind and a
   * string or numerical identifier, which identify entities. The first element identifies a _root
   * entity_, the second element identifies a _child_ of the root entity, the third element
   * identifies a child of the second entity, and so forth. The entities identified by all prefixes
   * of the path are called the element's _ancestors_.
   *
   * A path can never be empty, and a path can have at most 100 elements.
   * @param path path or {@code null} for none
   */
  public GooglePrivacyDlpV2beta1Key setPath(java.util.List path) {
    this.path = path;
    return this;
  }

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

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

}