Class Condition.Builder (1.56.0) 

public static final class Condition.Builder extends GeneratedMessageV3.Builder<Condition.Builder> implements ConditionOrBuilder

A condition necessary for an AccessLevel to be granted. The Condition is an AND over its fields. So a Condition is true if: 1) the request IP is from one of the listed subnetworks AND 2) the originating device complies with the listed device policy AND 3) all listed access levels are granted AND 4) the request was sent at a time allowed by the DateTimeRestriction.

Protobuf type google.identity.accesscontextmanager.v1.Condition

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Condition.Builder

Implements

ConditionOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllIpSubnetworks(Iterable<String> values)

public Condition.Builder addAllIpSubnetworks(Iterable<String> values)

CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed.

repeated string ip_subnetworks = 1;

Parameter
Name Description
values Iterable<String>

The ipSubnetworks to add.
Returns
Type Description
Condition.Builder

This builder for chaining.

addAllMembers(Iterable<String> values)

public Condition.Builder addAllMembers(Iterable<String> values)

The request must be made by one of the provided user or service accounts. Groups are not supported. Syntax: user:{emailid} serviceAccount:{emailid} If not specified, a request may come from any user.

repeated string members = 6;

Parameter
Name Description
values Iterable<String>

The members to add.
Returns
Type Description
Condition.Builder

This builder for chaining.

addAllRegions(Iterable<String> values)

public Condition.Builder addAllRegions(Iterable<String> values)

The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes.

repeated string regions = 7;

Parameter
Name Description
values Iterable<String>

The regions to add.
Returns
Type Description
Condition.Builder

This builder for chaining.

addAllRequiredAccessLevels(Iterable<String> values)

public Condition.Builder addAllRequiredAccessLevels(Iterable<String> values)

A list of other access levels defined in the same Policy, referenced by resource name. Referencing an AccessLevel which does not exist is an error. All access levels listed must be granted for the Condition to be true. Example: "accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"

repeated string required_access_levels = 3;

Parameter
Name Description
values Iterable<String>

The requiredAccessLevels to add.
Returns
Type Description
Condition.Builder

This builder for chaining.

addIpSubnetworks(String value)

public Condition.Builder addIpSubnetworks(String value)

CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed.

repeated string ip_subnetworks = 1;

Parameter
Name Description
value String

The ipSubnetworks to add.
Returns
Type Description
Condition.Builder

This builder for chaining.

addIpSubnetworksBytes(ByteString value)

public Condition.Builder addIpSubnetworksBytes(ByteString value)

CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed.

repeated string ip_subnetworks = 1;

Parameter
Name Description
value ByteString

The bytes of the ipSubnetworks to add.
Returns
Type Description
Condition.Builder

This builder for chaining.

addMembers(String value)

public Condition.Builder addMembers(String value)

The request must be made by one of the provided user or service accounts. Groups are not supported. Syntax: user:{emailid} serviceAccount:{emailid} If not specified, a request may come from any user.

repeated string members = 6;

Parameter
Name Description
value String

The members to add.
Returns
Type Description
Condition.Builder

This builder for chaining.

addMembersBytes(ByteString value)

public Condition.Builder addMembersBytes(ByteString value)

The request must be made by one of the provided user or service accounts. Groups are not supported. Syntax: user:{emailid} serviceAccount:{emailid} If not specified, a request may come from any user.

repeated string members = 6;

Parameter
Name Description
value ByteString

The bytes of the members to add.
Returns
Type Description
Condition.Builder

This builder for chaining.

addRegions(String value)

public Condition.Builder addRegions(String value)

The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes.

repeated string regions = 7;

Parameter
Name Description
value String

The regions to add.
Returns
Type Description
Condition.Builder

This builder for chaining.

addRegionsBytes(ByteString value)

public Condition.Builder addRegionsBytes(ByteString value)

The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes.

repeated string regions = 7;

Parameter
Name Description
value ByteString

The bytes of the regions to add.
Returns
Type Description
Condition.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Condition.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Condition.Builder
Overrides

addRequiredAccessLevels(String value)

public Condition.Builder addRequiredAccessLevels(String value)

A list of other access levels defined in the same Policy, referenced by resource name. Referencing an AccessLevel which does not exist is an error. All access levels listed must be granted for the Condition to be true. Example: "accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"

repeated string required_access_levels = 3;

Parameter
Name Description
value String

The requiredAccessLevels to add.
Returns
Type Description
Condition.Builder

This builder for chaining.

addRequiredAccessLevelsBytes(ByteString value)

public Condition.Builder addRequiredAccessLevelsBytes(ByteString value)

A list of other access levels defined in the same Policy, referenced by resource name. Referencing an AccessLevel which does not exist is an error. All access levels listed must be granted for the Condition to be true. Example: "accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"

repeated string required_access_levels = 3;

Parameter
Name Description
value ByteString

The bytes of the requiredAccessLevels to add.
Returns
Type Description
Condition.Builder

This builder for chaining.

build()

public Condition build()
Returns
Type Description
Condition

buildPartial()

public Condition buildPartial()
Returns
Type Description
Condition

clear()

public Condition.Builder clear()
Returns
Type Description
Condition.Builder
Overrides

clearDevicePolicy()

public Condition.Builder clearDevicePolicy()

Device specific restrictions, all restrictions must hold for the Condition to be true. If not specified, all devices are allowed.

.google.identity.accesscontextmanager.v1.DevicePolicy device_policy = 2;

Returns
Type Description
Condition.Builder

clearField(Descriptors.FieldDescriptor field)

public Condition.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Condition.Builder
Overrides

clearIpSubnetworks()

public Condition.Builder clearIpSubnetworks()

CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed.

repeated string ip_subnetworks = 1;

Returns
Type Description
Condition.Builder

This builder for chaining.

clearMembers()

public Condition.Builder clearMembers()

The request must be made by one of the provided user or service accounts. Groups are not supported. Syntax: user:{emailid} serviceAccount:{emailid} If not specified, a request may come from any user.

repeated string members = 6;

Returns
Type Description
Condition.Builder

This builder for chaining.

clearNegate()

public Condition.Builder clearNegate()

Whether to negate the Condition. If true, the Condition becomes a NAND over its non-empty fields, each field must be false for the Condition overall to be satisfied. Defaults to false.

bool negate = 5;

Returns
Type Description
Condition.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Condition.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Condition.Builder
Overrides

clearRegions()

public Condition.Builder clearRegions()

The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes.

repeated string regions = 7;

Returns
Type Description
Condition.Builder

This builder for chaining.

clearRequiredAccessLevels()

public Condition.Builder clearRequiredAccessLevels()

A list of other access levels defined in the same Policy, referenced by resource name. Referencing an AccessLevel which does not exist is an error. All access levels listed must be granted for the Condition to be true. Example: "accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"

repeated string required_access_levels = 3;

Returns
Type Description
Condition.Builder

This builder for chaining.

clone()

public Condition.Builder clone()
Returns
Type Description
Condition.Builder
Overrides

getDefaultInstanceForType()

public Condition getDefaultInstanceForType()
Returns
Type Description
Condition

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDevicePolicy()

public DevicePolicy getDevicePolicy()

Device specific restrictions, all restrictions must hold for the Condition to be true. If not specified, all devices are allowed.

.google.identity.accesscontextmanager.v1.DevicePolicy device_policy = 2;

Returns
Type Description
DevicePolicy

The devicePolicy.

getDevicePolicyBuilder()

public DevicePolicy.Builder getDevicePolicyBuilder()

Device specific restrictions, all restrictions must hold for the Condition to be true. If not specified, all devices are allowed.

.google.identity.accesscontextmanager.v1.DevicePolicy device_policy = 2;

Returns
Type Description
DevicePolicy.Builder

getDevicePolicyOrBuilder()

public DevicePolicyOrBuilder getDevicePolicyOrBuilder()

Device specific restrictions, all restrictions must hold for the Condition to be true. If not specified, all devices are allowed.

.google.identity.accesscontextmanager.v1.DevicePolicy device_policy = 2;

Returns
Type Description
DevicePolicyOrBuilder

getIpSubnetworks(int index)

public String getIpSubnetworks(int index)

CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed.

repeated string ip_subnetworks = 1;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The ipSubnetworks at the given index.

getIpSubnetworksBytes(int index)

public ByteString getIpSubnetworksBytes(int index)

CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed.

repeated string ip_subnetworks = 1;

Parameter
Name Description
index int

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

The bytes of the ipSubnetworks at the given index.

getIpSubnetworksCount()

public int getIpSubnetworksCount()

CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed.

repeated string ip_subnetworks = 1;

Returns
Type Description
int

The count of ipSubnetworks.

getIpSubnetworksList()

public ProtocolStringList getIpSubnetworksList()

CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed.

repeated string ip_subnetworks = 1;

Returns
Type Description
ProtocolStringList

A list containing the ipSubnetworks.

getMembers(int index)

public String getMembers(int index)

The request must be made by one of the provided user or service accounts. Groups are not supported. Syntax: user:{emailid} serviceAccount:{emailid} If not specified, a request may come from any user.

repeated string members = 6;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The members at the given index.

getMembersBytes(int index)

public ByteString getMembersBytes(int index)

The request must be made by one of the provided user or service accounts. Groups are not supported. Syntax: user:{emailid} serviceAccount:{emailid} If not specified, a request may come from any user.

repeated string members = 6;

Parameter
Name Description
index int

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

The bytes of the members at the given index.

getMembersCount()

public int getMembersCount()

The request must be made by one of the provided user or service accounts. Groups are not supported. Syntax: user:{emailid} serviceAccount:{emailid} If not specified, a request may come from any user.

repeated string members = 6;

Returns
Type Description
int

The count of members.

getMembersList()

public ProtocolStringList getMembersList()

The request must be made by one of the provided user or service accounts. Groups are not supported. Syntax: user:{emailid} serviceAccount:{emailid} If not specified, a request may come from any user.

repeated string members = 6;

Returns
Type Description
ProtocolStringList

A list containing the members.

getNegate()

public boolean getNegate()

Whether to negate the Condition. If true, the Condition becomes a NAND over its non-empty fields, each field must be false for the Condition overall to be satisfied. Defaults to false.

bool negate = 5;

Returns
Type Description
boolean

The negate.

getRegions(int index)

public String getRegions(int index)

The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes.

repeated string regions = 7;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The regions at the given index.

getRegionsBytes(int index)

public ByteString getRegionsBytes(int index)

The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes.

repeated string regions = 7;

Parameter
Name Description
index int

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

The bytes of the regions at the given index.

getRegionsCount()

public int getRegionsCount()

The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes.

repeated string regions = 7;

Returns
Type Description
int

The count of regions.

getRegionsList()

public ProtocolStringList getRegionsList()

The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes.

repeated string regions = 7;

Returns
Type Description
ProtocolStringList

A list containing the regions.

getRequiredAccessLevels(int index)

public String getRequiredAccessLevels(int index)

A list of other access levels defined in the same Policy, referenced by resource name. Referencing an AccessLevel which does not exist is an error. All access levels listed must be granted for the Condition to be true. Example: "accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"

repeated string required_access_levels = 3;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The requiredAccessLevels at the given index.

getRequiredAccessLevelsBytes(int index)

public ByteString getRequiredAccessLevelsBytes(int index)

A list of other access levels defined in the same Policy, referenced by resource name. Referencing an AccessLevel which does not exist is an error. All access levels listed must be granted for the Condition to be true. Example: "accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"

repeated string required_access_levels = 3;

Parameter
Name Description
index int

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

The bytes of the requiredAccessLevels at the given index.

getRequiredAccessLevelsCount()

public int getRequiredAccessLevelsCount()

A list of other access levels defined in the same Policy, referenced by resource name. Referencing an AccessLevel which does not exist is an error. All access levels listed must be granted for the Condition to be true. Example: "accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"

repeated string required_access_levels = 3;

Returns
Type Description
int

The count of requiredAccessLevels.

getRequiredAccessLevelsList()

public ProtocolStringList getRequiredAccessLevelsList()

A list of other access levels defined in the same Policy, referenced by resource name. Referencing an AccessLevel which does not exist is an error. All access levels listed must be granted for the Condition to be true. Example: "accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"

repeated string required_access_levels = 3;

Returns
Type Description
ProtocolStringList

A list containing the requiredAccessLevels.

hasDevicePolicy()

public boolean hasDevicePolicy()

Device specific restrictions, all restrictions must hold for the Condition to be true. If not specified, all devices are allowed.

.google.identity.accesscontextmanager.v1.DevicePolicy device_policy = 2;

Returns
Type Description
boolean

Whether the devicePolicy field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDevicePolicy(DevicePolicy value)

public Condition.Builder mergeDevicePolicy(DevicePolicy value)

Device specific restrictions, all restrictions must hold for the Condition to be true. If not specified, all devices are allowed.

.google.identity.accesscontextmanager.v1.DevicePolicy device_policy = 2;

Parameter
Name Description
value DevicePolicy
Returns
Type Description
Condition.Builder

mergeFrom(Condition other)

public Condition.Builder mergeFrom(Condition other)
Parameter
Name Description
other Condition
Returns
Type Description
Condition.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Condition.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Condition.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Condition.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Condition.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Condition.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Condition.Builder
Overrides

setDevicePolicy(DevicePolicy value)

public Condition.Builder setDevicePolicy(DevicePolicy value)

Device specific restrictions, all restrictions must hold for the Condition to be true. If not specified, all devices are allowed.

.google.identity.accesscontextmanager.v1.DevicePolicy device_policy = 2;

Parameter
Name Description
value DevicePolicy
Returns
Type Description
Condition.Builder

setDevicePolicy(DevicePolicy.Builder builderForValue)

public Condition.Builder setDevicePolicy(DevicePolicy.Builder builderForValue)

Device specific restrictions, all restrictions must hold for the Condition to be true. If not specified, all devices are allowed.

.google.identity.accesscontextmanager.v1.DevicePolicy device_policy = 2;

Parameter
Name Description
builderForValue DevicePolicy.Builder
Returns
Type Description
Condition.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Condition.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Condition.Builder
Overrides

setIpSubnetworks(int index, String value)

public Condition.Builder setIpSubnetworks(int index, String value)

CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed.

repeated string ip_subnetworks = 1;

Parameters
Name Description
index int

The index to set the value at.
value String

The ipSubnetworks to set.
Returns
Type Description
Condition.Builder

This builder for chaining.

setMembers(int index, String value)

public Condition.Builder setMembers(int index, String value)

The request must be made by one of the provided user or service accounts. Groups are not supported. Syntax: user:{emailid} serviceAccount:{emailid} If not specified, a request may come from any user.

repeated string members = 6;

Parameters
Name Description
index int

The index to set the value at.
value String

The members to set.
Returns
Type Description
Condition.Builder

This builder for chaining.

setNegate(boolean value)

public Condition.Builder setNegate(boolean value)

Whether to negate the Condition. If true, the Condition becomes a NAND over its non-empty fields, each field must be false for the Condition overall to be satisfied. Defaults to false.

bool negate = 5;

Parameter
Name Description
value boolean

The negate to set.
Returns
Type Description
Condition.Builder

This builder for chaining.

setRegions(int index, String value)

public Condition.Builder setRegions(int index, String value)

The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes.

repeated string regions = 7;

Parameters
Name Description
index int

The index to set the value at.
value String

The regions to set.
Returns
Type Description
Condition.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Condition.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Condition.Builder
Overrides

setRequiredAccessLevels(int index, String value)

public Condition.Builder setRequiredAccessLevels(int index, String value)

A list of other access levels defined in the same Policy, referenced by resource name. Referencing an AccessLevel which does not exist is an error. All access levels listed must be granted for the Condition to be true. Example: "accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"

repeated string required_access_levels = 3;

Parameters
Name Description
index int

The index to set the value at.
value String

The requiredAccessLevels to set.
Returns
Type Description
Condition.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Condition.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Condition.Builder
Overrides