Interface AttributePropagationSettingsOrBuilder (0.1.0)

public interface AttributePropagationSettingsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getEnable()

public abstract boolean getEnable()

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;

Returns
Type Description
boolean

The enable.

getExpression()

public abstract String getExpression()

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;

Returns
Type Description
String

The expression.

getExpressionBytes()

public abstract ByteString getExpressionBytes()

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;

Returns
Type Description
ByteString

The bytes for expression.

getOutputCredentials(int index)

public abstract AttributePropagationSettings.OutputCredentials getOutputCredentials(int index)

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;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
AttributePropagationSettings.OutputCredentials

The outputCredentials at the given index.

getOutputCredentialsCount()

public abstract int getOutputCredentialsCount()

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;

Returns
Type Description
int

The count of outputCredentials.

getOutputCredentialsList()

public abstract List<AttributePropagationSettings.OutputCredentials> getOutputCredentialsList()

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;

Returns
Type Description
List<OutputCredentials>

A list containing the outputCredentials.

getOutputCredentialsValue(int index)

public abstract int getOutputCredentialsValue(int index)

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;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of outputCredentials at the given index.

getOutputCredentialsValueList()

public abstract List<Integer> getOutputCredentialsValueList()

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;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for outputCredentials.

hasEnable()

public abstract boolean hasEnable()

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;

Returns
Type Description
boolean

Whether the enable field is set.

hasExpression()

public abstract boolean hasExpression()

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;

Returns
Type Description
boolean

Whether the expression field is set.