Class Policy.Builder (1.54.0)

public static final class Policy.Builder extends GeneratedMessageV3.Builder<Policy.Builder> implements PolicyOrBuilder

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: <code><code> { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike&#64;example.com", "group:admins&#64;example.com", "domain:google.com", "serviceAccount:my-project-id&#64;appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve&#64;example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } </code></code><code> **YAML example:** </code><code><code> bindings: - members: - user:mike&#64;example.com - group:admins&#64;example.com - domain:google.com - serviceAccount:my-project-id&#64;appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve&#64;example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 </code></code> For a description of IAM and its features, see the IAM documentation.

Protobuf type google.cloud.compute.v1.Policy

Implements

PolicyOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllAuditConfigs(Iterable<? extends AuditConfig> values)

public Policy.Builder addAllAuditConfigs(Iterable<? extends AuditConfig> values)

Specifies cloud audit logging configuration for this policy.

repeated .google.cloud.compute.v1.AuditConfig audit_configs = 328080653;

Parameter
Name Description
values Iterable<? extends com.google.cloud.compute.v1.AuditConfig>
Returns
Type Description
Policy.Builder

addAllBindings(Iterable<? extends Binding> values)

public Policy.Builder addAllBindings(Iterable<? extends Binding> values)

Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal. The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.

repeated .google.cloud.compute.v1.Binding bindings = 403251854;

Parameter
Name Description
values Iterable<? extends com.google.cloud.compute.v1.Binding>
Returns
Type Description
Policy.Builder

addAllRules(Iterable<? extends Rule> values)

public Policy.Builder addAllRules(Iterable<? extends Rule> values)

This is deprecated and has no effect. Do not use.

repeated .google.cloud.compute.v1.Rule rules = 108873975;

Parameter
Name Description
values Iterable<? extends com.google.cloud.compute.v1.Rule>
Returns
Type Description
Policy.Builder

addAuditConfigs(AuditConfig value)

public Policy.Builder addAuditConfigs(AuditConfig value)

Specifies cloud audit logging configuration for this policy.

repeated .google.cloud.compute.v1.AuditConfig audit_configs = 328080653;

Parameter
Name Description
value AuditConfig
Returns
Type Description
Policy.Builder

addAuditConfigs(AuditConfig.Builder builderForValue)

public Policy.Builder addAuditConfigs(AuditConfig.Builder builderForValue)

Specifies cloud audit logging configuration for this policy.

repeated .google.cloud.compute.v1.AuditConfig audit_configs = 328080653;

Parameter
Name Description
builderForValue AuditConfig.Builder
Returns
Type Description
Policy.Builder

addAuditConfigs(int index, AuditConfig value)

public Policy.Builder addAuditConfigs(int index, AuditConfig value)

Specifies cloud audit logging configuration for this policy.

repeated .google.cloud.compute.v1.AuditConfig audit_configs = 328080653;

Parameters
Name Description
index int
value AuditConfig
Returns
Type Description
Policy.Builder

addAuditConfigs(int index, AuditConfig.Builder builderForValue)

public Policy.Builder addAuditConfigs(int index, AuditConfig.Builder builderForValue)

Specifies cloud audit logging configuration for this policy.

repeated .google.cloud.compute.v1.AuditConfig audit_configs = 328080653;

Parameters
Name Description
index int
builderForValue AuditConfig.Builder
Returns
Type Description
Policy.Builder

addAuditConfigsBuilder()

public AuditConfig.Builder addAuditConfigsBuilder()

Specifies cloud audit logging configuration for this policy.

repeated .google.cloud.compute.v1.AuditConfig audit_configs = 328080653;

Returns
Type Description
AuditConfig.Builder

addAuditConfigsBuilder(int index)

public AuditConfig.Builder addAuditConfigsBuilder(int index)

Specifies cloud audit logging configuration for this policy.

repeated .google.cloud.compute.v1.AuditConfig audit_configs = 328080653;

Parameter
Name Description
index int
Returns
Type Description
AuditConfig.Builder

addBindings(Binding value)

public Policy.Builder addBindings(Binding value)

Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal. The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.

repeated .google.cloud.compute.v1.Binding bindings = 403251854;

Parameter
Name Description
value Binding
Returns
Type Description
Policy.Builder

addBindings(Binding.Builder builderForValue)

public Policy.Builder addBindings(Binding.Builder builderForValue)

Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal. The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.

repeated .google.cloud.compute.v1.Binding bindings = 403251854;

Parameter
Name Description
builderForValue Binding.Builder
Returns
Type Description
Policy.Builder

addBindings(int index, Binding value)

public Policy.Builder addBindings(int index, Binding value)

Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal. The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.

repeated .google.cloud.compute.v1.Binding bindings = 403251854;

Parameters
Name Description
index int
value Binding
Returns
Type Description
Policy.Builder

addBindings(int index, Binding.Builder builderForValue)

public Policy.Builder addBindings(int index, Binding.Builder builderForValue)

Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal. The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.

repeated .google.cloud.compute.v1.Binding bindings = 403251854;

Parameters
Name Description
index int
builderForValue Binding.Builder
Returns
Type Description
Policy.Builder

addBindingsBuilder()

public Binding.Builder addBindingsBuilder()

Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal. The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.

repeated .google.cloud.compute.v1.Binding bindings = 403251854;

Returns
Type Description
Binding.Builder

addBindingsBuilder(int index)

public Binding.Builder addBindingsBuilder(int index)

Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal. The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.

repeated .google.cloud.compute.v1.Binding bindings = 403251854;

Parameter
Name Description
index int
Returns
Type Description
Binding.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addRules(Rule value)

public Policy.Builder addRules(Rule value)

This is deprecated and has no effect. Do not use.

repeated .google.cloud.compute.v1.Rule rules = 108873975;

Parameter
Name Description
value Rule
Returns
Type Description
Policy.Builder

addRules(Rule.Builder builderForValue)

public Policy.Builder addRules(Rule.Builder builderForValue)

This is deprecated and has no effect. Do not use.

repeated .google.cloud.compute.v1.Rule rules = 108873975;

Parameter
Name Description
builderForValue Rule.Builder
Returns
Type Description
Policy.Builder

addRules(int index, Rule value)

public Policy.Builder addRules(int index, Rule value)

This is deprecated and has no effect. Do not use.

repeated .google.cloud.compute.v1.Rule rules = 108873975;

Parameters
Name Description
index int
value Rule
Returns
Type Description
Policy.Builder

addRules(int index, Rule.Builder builderForValue)

public Policy.Builder addRules(int index, Rule.Builder builderForValue)

This is deprecated and has no effect. Do not use.

repeated .google.cloud.compute.v1.Rule rules = 108873975;

Parameters
Name Description
index int
builderForValue Rule.Builder
Returns
Type Description
Policy.Builder

addRulesBuilder()

public Rule.Builder addRulesBuilder()

This is deprecated and has no effect. Do not use.

repeated .google.cloud.compute.v1.Rule rules = 108873975;

Returns
Type Description
Rule.Builder

addRulesBuilder(int index)

public Rule.Builder addRulesBuilder(int index)

This is deprecated and has no effect. Do not use.

repeated .google.cloud.compute.v1.Rule rules = 108873975;

Parameter
Name Description
index int
Returns
Type Description
Rule.Builder

build()

public Policy build()
Returns
Type Description
Policy

buildPartial()

public Policy buildPartial()
Returns
Type Description
Policy

clear()

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

clearAuditConfigs()

public Policy.Builder clearAuditConfigs()

Specifies cloud audit logging configuration for this policy.

repeated .google.cloud.compute.v1.AuditConfig audit_configs = 328080653;

Returns
Type Description
Policy.Builder

clearBindings()

public Policy.Builder clearBindings()

Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal. The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.

repeated .google.cloud.compute.v1.Binding bindings = 403251854;

Returns
Type Description
Policy.Builder

clearEtag()

public Policy.Builder clearEtag()

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy. Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.

optional string etag = 3123477;

Returns
Type Description
Policy.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearIamOwned()

public Policy.Builder clearIamOwned()

optional bool iam_owned = 450566203;

Returns
Type Description
Policy.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRules()

public Policy.Builder clearRules()

This is deprecated and has no effect. Do not use.

repeated .google.cloud.compute.v1.Rule rules = 108873975;

Returns
Type Description
Policy.Builder

clearVersion()

public Policy.Builder clearVersion()

Specifies the format of the policy. Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation.

optional int32 version = 351608024;

Returns
Type Description
Policy.Builder

This builder for chaining.

clone()

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

getAuditConfigs(int index)

public AuditConfig getAuditConfigs(int index)

Specifies cloud audit logging configuration for this policy.

repeated .google.cloud.compute.v1.AuditConfig audit_configs = 328080653;

Parameter
Name Description
index int
Returns
Type Description
AuditConfig

getAuditConfigsBuilder(int index)

public AuditConfig.Builder getAuditConfigsBuilder(int index)

Specifies cloud audit logging configuration for this policy.

repeated .google.cloud.compute.v1.AuditConfig audit_configs = 328080653;

Parameter
Name Description
index int
Returns
Type Description
AuditConfig.Builder

getAuditConfigsBuilderList()

public List<AuditConfig.Builder> getAuditConfigsBuilderList()

Specifies cloud audit logging configuration for this policy.

repeated .google.cloud.compute.v1.AuditConfig audit_configs = 328080653;

Returns
Type Description
List<Builder>

getAuditConfigsCount()

public int getAuditConfigsCount()

Specifies cloud audit logging configuration for this policy.

repeated .google.cloud.compute.v1.AuditConfig audit_configs = 328080653;

Returns
Type Description
int

getAuditConfigsList()

public List<AuditConfig> getAuditConfigsList()

Specifies cloud audit logging configuration for this policy.

repeated .google.cloud.compute.v1.AuditConfig audit_configs = 328080653;

Returns
Type Description
List<AuditConfig>

getAuditConfigsOrBuilder(int index)

public AuditConfigOrBuilder getAuditConfigsOrBuilder(int index)

Specifies cloud audit logging configuration for this policy.

repeated .google.cloud.compute.v1.AuditConfig audit_configs = 328080653;

Parameter
Name Description
index int
Returns
Type Description
AuditConfigOrBuilder

getAuditConfigsOrBuilderList()

public List<? extends AuditConfigOrBuilder> getAuditConfigsOrBuilderList()

Specifies cloud audit logging configuration for this policy.

repeated .google.cloud.compute.v1.AuditConfig audit_configs = 328080653;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.AuditConfigOrBuilder>

getBindings(int index)

public Binding getBindings(int index)

Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal. The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.

repeated .google.cloud.compute.v1.Binding bindings = 403251854;

Parameter
Name Description
index int
Returns
Type Description
Binding

getBindingsBuilder(int index)

public Binding.Builder getBindingsBuilder(int index)

Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal. The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.

repeated .google.cloud.compute.v1.Binding bindings = 403251854;

Parameter
Name Description
index int
Returns
Type Description
Binding.Builder

getBindingsBuilderList()

public List<Binding.Builder> getBindingsBuilderList()

Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal. The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.

repeated .google.cloud.compute.v1.Binding bindings = 403251854;

Returns
Type Description
List<Builder>

getBindingsCount()

public int getBindingsCount()

Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal. The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.

repeated .google.cloud.compute.v1.Binding bindings = 403251854;

Returns
Type Description
int

getBindingsList()

public List<Binding> getBindingsList()

Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal. The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.

repeated .google.cloud.compute.v1.Binding bindings = 403251854;

Returns
Type Description
List<Binding>

getBindingsOrBuilder(int index)

public BindingOrBuilder getBindingsOrBuilder(int index)

Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal. The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.

repeated .google.cloud.compute.v1.Binding bindings = 403251854;

Parameter
Name Description
index int
Returns
Type Description
BindingOrBuilder

getBindingsOrBuilderList()

public List<? extends BindingOrBuilder> getBindingsOrBuilderList()

Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal. The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.

repeated .google.cloud.compute.v1.Binding bindings = 403251854;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.BindingOrBuilder>

getDefaultInstanceForType()

public Policy getDefaultInstanceForType()
Returns
Type Description
Policy

getDescriptorForType()

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

getEtag()

public String getEtag()

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy. Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.

optional string etag = 3123477;

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy. Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.

optional string etag = 3123477;

Returns
Type Description
ByteString

The bytes for etag.

getIamOwned()

public boolean getIamOwned()

optional bool iam_owned = 450566203;

Returns
Type Description
boolean

The iamOwned.

getRules(int index)

public Rule getRules(int index)

This is deprecated and has no effect. Do not use.

repeated .google.cloud.compute.v1.Rule rules = 108873975;

Parameter
Name Description
index int
Returns
Type Description
Rule

getRulesBuilder(int index)

public Rule.Builder getRulesBuilder(int index)

This is deprecated and has no effect. Do not use.

repeated .google.cloud.compute.v1.Rule rules = 108873975;

Parameter
Name Description
index int
Returns
Type Description
Rule.Builder

getRulesBuilderList()

public List<Rule.Builder> getRulesBuilderList()

This is deprecated and has no effect. Do not use.

repeated .google.cloud.compute.v1.Rule rules = 108873975;

Returns
Type Description
List<Builder>

getRulesCount()

public int getRulesCount()

This is deprecated and has no effect. Do not use.

repeated .google.cloud.compute.v1.Rule rules = 108873975;

Returns
Type Description
int

getRulesList()

public List<Rule> getRulesList()

This is deprecated and has no effect. Do not use.

repeated .google.cloud.compute.v1.Rule rules = 108873975;

Returns
Type Description
List<Rule>

getRulesOrBuilder(int index)

public RuleOrBuilder getRulesOrBuilder(int index)

This is deprecated and has no effect. Do not use.

repeated .google.cloud.compute.v1.Rule rules = 108873975;

Parameter
Name Description
index int
Returns
Type Description
RuleOrBuilder

getRulesOrBuilderList()

public List<? extends RuleOrBuilder> getRulesOrBuilderList()

This is deprecated and has no effect. Do not use.

repeated .google.cloud.compute.v1.Rule rules = 108873975;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.RuleOrBuilder>

getVersion()

public int getVersion()

Specifies the format of the policy. Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation.

optional int32 version = 351608024;

Returns
Type Description
int

The version.

hasEtag()

public boolean hasEtag()

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy. Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.

optional string etag = 3123477;

Returns
Type Description
boolean

Whether the etag field is set.

hasIamOwned()

public boolean hasIamOwned()

optional bool iam_owned = 450566203;

Returns
Type Description
boolean

Whether the iamOwned field is set.

hasVersion()

public boolean hasVersion()

Specifies the format of the policy. Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation.

optional int32 version = 351608024;

Returns
Type Description
boolean

Whether the version field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Policy other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeAuditConfigs(int index)

public Policy.Builder removeAuditConfigs(int index)

Specifies cloud audit logging configuration for this policy.

repeated .google.cloud.compute.v1.AuditConfig audit_configs = 328080653;

Parameter
Name Description
index int
Returns
Type Description
Policy.Builder

removeBindings(int index)

public Policy.Builder removeBindings(int index)

Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal. The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.

repeated .google.cloud.compute.v1.Binding bindings = 403251854;

Parameter
Name Description
index int
Returns
Type Description
Policy.Builder

removeRules(int index)

public Policy.Builder removeRules(int index)

This is deprecated and has no effect. Do not use.

repeated .google.cloud.compute.v1.Rule rules = 108873975;

Parameter
Name Description
index int
Returns
Type Description
Policy.Builder

setAuditConfigs(int index, AuditConfig value)

public Policy.Builder setAuditConfigs(int index, AuditConfig value)

Specifies cloud audit logging configuration for this policy.

repeated .google.cloud.compute.v1.AuditConfig audit_configs = 328080653;

Parameters
Name Description
index int
value AuditConfig
Returns
Type Description
Policy.Builder

setAuditConfigs(int index, AuditConfig.Builder builderForValue)

public Policy.Builder setAuditConfigs(int index, AuditConfig.Builder builderForValue)

Specifies cloud audit logging configuration for this policy.

repeated .google.cloud.compute.v1.AuditConfig audit_configs = 328080653;

Parameters
Name Description
index int
builderForValue AuditConfig.Builder
Returns
Type Description
Policy.Builder

setBindings(int index, Binding value)

public Policy.Builder setBindings(int index, Binding value)

Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal. The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.

repeated .google.cloud.compute.v1.Binding bindings = 403251854;

Parameters
Name Description
index int
value Binding
Returns
Type Description
Policy.Builder

setBindings(int index, Binding.Builder builderForValue)

public Policy.Builder setBindings(int index, Binding.Builder builderForValue)

Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal. The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.

repeated .google.cloud.compute.v1.Binding bindings = 403251854;

Parameters
Name Description
index int
builderForValue Binding.Builder
Returns
Type Description
Policy.Builder

setEtag(String value)

public Policy.Builder setEtag(String value)

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy. Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.

optional string etag = 3123477;

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
Policy.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public Policy.Builder setEtagBytes(ByteString value)

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy. Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.

optional string etag = 3123477;

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
Policy.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setIamOwned(boolean value)

public Policy.Builder setIamOwned(boolean value)

optional bool iam_owned = 450566203;

Parameter
Name Description
value boolean

The iamOwned to set.

Returns
Type Description
Policy.Builder

This builder for chaining.

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

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

setRules(int index, Rule value)

public Policy.Builder setRules(int index, Rule value)

This is deprecated and has no effect. Do not use.

repeated .google.cloud.compute.v1.Rule rules = 108873975;

Parameters
Name Description
index int
value Rule
Returns
Type Description
Policy.Builder

setRules(int index, Rule.Builder builderForValue)

public Policy.Builder setRules(int index, Rule.Builder builderForValue)

This is deprecated and has no effect. Do not use.

repeated .google.cloud.compute.v1.Rule rules = 108873975;

Parameters
Name Description
index int
builderForValue Rule.Builder
Returns
Type Description
Policy.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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

setVersion(int value)

public Policy.Builder setVersion(int value)

Specifies the format of the policy. Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation.

optional int32 version = 351608024;

Parameter
Name Description
value int

The version to set.

Returns
Type Description
Policy.Builder

This builder for chaining.