Package com.google.cloud.iap.v1

Interface AttributePropagationSettingsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AttributePropagationSettings, AttributePropagationSettings.Builder
@Generated public interface AttributePropagationSettingsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasExpression

      boolean hasExpression()
       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 `<list>.filter(<iter_var>, <predicate>)`: Returns a subset of
 `<list>` where `<predicate>` is true for every item.

 - in `<var> in <list>`: Returns true if `<list>` contains `<var>`.

 - selectByName `<list>.selectByName(<string>)`: Returns the attribute
 in
 `<list>` with the given `<string>` name, otherwise returns empty.

 - emitAs `<attribute>.emitAs(<string>)`: Sets the `<attribute>` name
 field to the given `<string>` for propagation in selected output
 credentials.

 - strict `<attribute>.strict()`: Ignores the `x-goog-iap-attr-` prefix
 for the provided `<attribute>` when propagating with the `HEADER` output
 credential, such as request headers.

 - append `<target_list>.append(<attribute>)` OR
 `<target_list>.append(<list>)`: Appends the provided `<attribute>` or
 `<list>` to the end of `<target_list>`.

 Example expression: `attributes.saml_attributes.filter(x, x.name in
 ['test']).append(attributes.iap_attributes.selectByName('exact').emitAs('custom').strict())`
      optional string expression = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the expression field is set.

    • getExpression

      String getExpression()
       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 `<list>.filter(<iter_var>, <predicate>)`: Returns a subset of
 `<list>` where `<predicate>` is true for every item.

 - in `<var> in <list>`: Returns true if `<list>` contains `<var>`.

 - selectByName `<list>.selectByName(<string>)`: Returns the attribute
 in
 `<list>` with the given `<string>` name, otherwise returns empty.

 - emitAs `<attribute>.emitAs(<string>)`: Sets the `<attribute>` name
 field to the given `<string>` for propagation in selected output
 credentials.

 - strict `<attribute>.strict()`: Ignores the `x-goog-iap-attr-` prefix
 for the provided `<attribute>` when propagating with the `HEADER` output
 credential, such as request headers.

 - append `<target_list>.append(<attribute>)` OR
 `<target_list>.append(<list>)`: Appends the provided `<attribute>` or
 `<list>` to the end of `<target_list>`.

 Example expression: `attributes.saml_attributes.filter(x, x.name in
 ['test']).append(attributes.iap_attributes.selectByName('exact').emitAs('custom').strict())`
      optional string expression = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The expression.

    • getExpressionBytes

      com.google.protobuf.ByteString getExpressionBytes()
       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 `<list>.filter(<iter_var>, <predicate>)`: Returns a subset of
 `<list>` where `<predicate>` is true for every item.

 - in `<var> in <list>`: Returns true if `<list>` contains `<var>`.

 - selectByName `<list>.selectByName(<string>)`: Returns the attribute
 in
 `<list>` with the given `<string>` name, otherwise returns empty.

 - emitAs `<attribute>.emitAs(<string>)`: Sets the `<attribute>` name
 field to the given `<string>` for propagation in selected output
 credentials.

 - strict `<attribute>.strict()`: Ignores the `x-goog-iap-attr-` prefix
 for the provided `<attribute>` when propagating with the `HEADER` output
 credential, such as request headers.

 - append `<target_list>.append(<attribute>)` OR
 `<target_list>.append(<list>)`: Appends the provided `<attribute>` or
 `<list>` to the end of `<target_list>`.

 Example expression: `attributes.saml_attributes.filter(x, x.name in
 ['test']).append(attributes.iap_attributes.selectByName('exact').emitAs('custom').strict())`
      optional string expression = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for expression.

    • getOutputCredentialsList

      List<AttributePropagationSettings.OutputCredentials> getOutputCredentialsList()
       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.
      repeated .google.cloud.iap.v1.AttributePropagationSettings.OutputCredentials output_credentials = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the outputCredentials.

    • getOutputCredentialsCount

      int getOutputCredentialsCount()
       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.
      repeated .google.cloud.iap.v1.AttributePropagationSettings.OutputCredentials output_credentials = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The count of outputCredentials.

    • getOutputCredentials

      AttributePropagationSettings.OutputCredentials getOutputCredentials(int index)
       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.
      repeated .google.cloud.iap.v1.AttributePropagationSettings.OutputCredentials output_credentials = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the element to return.
      Returns:
      The outputCredentials at the given index.

    • getOutputCredentialsValueList

      List<Integer> getOutputCredentialsValueList()
       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.
      repeated .google.cloud.iap.v1.AttributePropagationSettings.OutputCredentials output_credentials = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the enum numeric values on the wire for outputCredentials.

    • getOutputCredentialsValue

      int getOutputCredentialsValue(int index)
       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.
      repeated .google.cloud.iap.v1.AttributePropagationSettings.OutputCredentials output_credentials = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of outputCredentials at the given index.

    • hasEnable

      boolean hasEnable()
       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.
      optional bool enable = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the enable field is set.

    • getEnable

      boolean getEnable()
       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.
      optional bool enable = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enable.