com.google.api.services.iap.v1.model.AttributePropagationSettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-iap Show documentation
There is a newer version: v1-rev20240909-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.iap.v1.model;

/**
 * Configuration for propagating attributes to applications protected by IAP.
 *
 *  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 Identity-Aware Proxy 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 AttributePropagationSettings extends com.google.api.client.json.GenericJson {

  /**
   * Optional. Whether the provided attribute propagation settings should be evaluated on user
   * requests. If set to true, attributes returned from the expression will be propagated in the set
   * output credentials.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean enable;

  /**
   * Optional. Raw string CEL expression. Must return a list of attributes. A maximum of 45
   * attributes can be selected. Expressions can select different attribute types from `attributes`:
   * `attributes.saml_attributes`, `attributes.iap_attributes`. The following functions are
   * supported: - filter `.filter(, )`: Returns a subset of `` where `` is true for every item. - in
   * ` in `: Returns true if `` contains ``. - selectByName `.selectByName()`: Returns the attribute
   * in `` with the given `` name, otherwise returns empty. - emitAs `.emitAs()`: Sets the `` name
   * field to the given `` for propagation in selected output credentials. - strict `.strict()`:
   * Ignores the `x-goog-iap-attr-` prefix for the provided `` when propagating with the `HEADER`
   * output credential, such as request headers. - append `.append()` OR `.append()`: Appends the
   * provided `` or `` to the end of ``. Example expression: `attributes.saml_attributes.filter(x,
   * x.name in
   * ['test']).append(attributes.iap_attributes.selectByName('exact').emitAs('custom').strict())`
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String expression;

  /**
   * Optional. Which output credentials attributes selected by the CEL expression should be
   * propagated in. All attributes will be fully duplicated in each selected output credential.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List outputCredentials;

  /**
   * Optional. Whether the provided attribute propagation settings should be evaluated on user
   * requests. If set to true, attributes returned from the expression will be propagated in the set
   * output credentials.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getEnable() {
    return enable;
  }

  /**
   * Optional. Whether the provided attribute propagation settings should be evaluated on user
   * requests. If set to true, attributes returned from the expression will be propagated in the set
   * output credentials.
   * @param enable enable or {@code null} for none
   */
  public AttributePropagationSettings setEnable(java.lang.Boolean enable) {
    this.enable = enable;
    return this;
  }

  /**
   * Optional. Raw string CEL expression. Must return a list of attributes. A maximum of 45
   * attributes can be selected. Expressions can select different attribute types from `attributes`:
   * `attributes.saml_attributes`, `attributes.iap_attributes`. The following functions are
   * supported: - filter `.filter(, )`: Returns a subset of `` where `` is true for every item. - in
   * ` in `: Returns true if `` contains ``. - selectByName `.selectByName()`: Returns the attribute
   * in `` with the given `` name, otherwise returns empty. - emitAs `.emitAs()`: Sets the `` name
   * field to the given `` for propagation in selected output credentials. - strict `.strict()`:
   * Ignores the `x-goog-iap-attr-` prefix for the provided `` when propagating with the `HEADER`
   * output credential, such as request headers. - append `.append()` OR `.append()`: Appends the
   * provided `` or `` to the end of ``. Example expression: `attributes.saml_attributes.filter(x,
   * x.name in
   * ['test']).append(attributes.iap_attributes.selectByName('exact').emitAs('custom').strict())`
   * @return value or {@code null} for none
   */
  public java.lang.String getExpression() {
    return expression;
  }

  /**
   * Optional. Raw string CEL expression. Must return a list of attributes. A maximum of 45
   * attributes can be selected. Expressions can select different attribute types from `attributes`:
   * `attributes.saml_attributes`, `attributes.iap_attributes`. The following functions are
   * supported: - filter `.filter(, )`: Returns a subset of `` where `` is true for every item. - in
   * ` in `: Returns true if `` contains ``. - selectByName `.selectByName()`: Returns the attribute
   * in `` with the given `` name, otherwise returns empty. - emitAs `.emitAs()`: Sets the `` name
   * field to the given `` for propagation in selected output credentials. - strict `.strict()`:
   * Ignores the `x-goog-iap-attr-` prefix for the provided `` when propagating with the `HEADER`
   * output credential, such as request headers. - append `.append()` OR `.append()`: Appends the
   * provided `` or `` to the end of ``. Example expression: `attributes.saml_attributes.filter(x,
   * x.name in
   * ['test']).append(attributes.iap_attributes.selectByName('exact').emitAs('custom').strict())`
   * @param expression expression or {@code null} for none
   */
  public AttributePropagationSettings setExpression(java.lang.String expression) {
    this.expression = expression;
    return this;
  }

  /**
   * Optional. Which output credentials attributes selected by the CEL expression should be
   * propagated in. All attributes will be fully duplicated in each selected output credential.
   * @return value or {@code null} for none
   */
  public java.util.List getOutputCredentials() {
    return outputCredentials;
  }

  /**
   * Optional. Which output credentials attributes selected by the CEL expression should be
   * propagated in. All attributes will be fully duplicated in each selected output credential.
   * @param outputCredentials outputCredentials or {@code null} for none
   */
  public AttributePropagationSettings setOutputCredentials(java.util.List outputCredentials) {
    this.outputCredentials = outputCredentials;
    return this;
  }

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

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

}