Class Explanations.ExplainedPolicy.Builder (1.4.0)

public static final class Explanations.ExplainedPolicy.Builder extends GeneratedMessageV3.Builder<Explanations.ExplainedPolicy.Builder> implements Explanations.ExplainedPolicyOrBuilder

Details about how a specific IAM Policy contributed to the access check.

Protobuf type google.cloud.policytroubleshooter.v1.ExplainedPolicy

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllBindingExplanations(Iterable<? extends Explanations.BindingExplanation> values)

public Explanations.ExplainedPolicy.Builder addAllBindingExplanations(Iterable<? extends Explanations.BindingExplanation> values)

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.v1.BindingExplanation binding_explanations = 4;

Parameter
NameDescription
valuesIterable<? extends google.cloud.policytroubleshooter.v1.Explanations.BindingExplanation>
Returns
TypeDescription
Explanations.ExplainedPolicy.Builder

addBindingExplanations(Explanations.BindingExplanation value)

public Explanations.ExplainedPolicy.Builder addBindingExplanations(Explanations.BindingExplanation value)

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.v1.BindingExplanation binding_explanations = 4;

Parameter
NameDescription
valueExplanations.BindingExplanation
Returns
TypeDescription
Explanations.ExplainedPolicy.Builder

addBindingExplanations(Explanations.BindingExplanation.Builder builderForValue)

public Explanations.ExplainedPolicy.Builder addBindingExplanations(Explanations.BindingExplanation.Builder builderForValue)

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.v1.BindingExplanation binding_explanations = 4;

Parameter
NameDescription
builderForValueExplanations.BindingExplanation.Builder
Returns
TypeDescription
Explanations.ExplainedPolicy.Builder

addBindingExplanations(int index, Explanations.BindingExplanation value)

public Explanations.ExplainedPolicy.Builder addBindingExplanations(int index, Explanations.BindingExplanation value)

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.v1.BindingExplanation binding_explanations = 4;

Parameters
NameDescription
indexint
valueExplanations.BindingExplanation
Returns
TypeDescription
Explanations.ExplainedPolicy.Builder

addBindingExplanations(int index, Explanations.BindingExplanation.Builder builderForValue)

public Explanations.ExplainedPolicy.Builder addBindingExplanations(int index, Explanations.BindingExplanation.Builder builderForValue)

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.v1.BindingExplanation binding_explanations = 4;

Parameters
NameDescription
indexint
builderForValueExplanations.BindingExplanation.Builder
Returns
TypeDescription
Explanations.ExplainedPolicy.Builder

addBindingExplanationsBuilder()

public Explanations.BindingExplanation.Builder addBindingExplanationsBuilder()

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.v1.BindingExplanation binding_explanations = 4;

Returns
TypeDescription
Explanations.BindingExplanation.Builder

addBindingExplanationsBuilder(int index)

public Explanations.BindingExplanation.Builder addBindingExplanationsBuilder(int index)

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.v1.BindingExplanation binding_explanations = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
Explanations.BindingExplanation.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Explanations.ExplainedPolicy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Explanations.ExplainedPolicy.Builder
Overrides

build()

public Explanations.ExplainedPolicy build()
Returns
TypeDescription
Explanations.ExplainedPolicy

buildPartial()

public Explanations.ExplainedPolicy buildPartial()
Returns
TypeDescription
Explanations.ExplainedPolicy

clear()

public Explanations.ExplainedPolicy.Builder clear()
Returns
TypeDescription
Explanations.ExplainedPolicy.Builder
Overrides

clearAccess()

public Explanations.ExplainedPolicy.Builder clearAccess()

Indicates whether this policy provides the specified permission to the specified member for the specified resource. This field does not indicate whether the member actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the member actually has the permission, use the access field in the TroubleshootIamPolicyResponse.

.google.cloud.policytroubleshooter.v1.AccessState access = 1;

Returns
TypeDescription
Explanations.ExplainedPolicy.Builder

This builder for chaining.

clearBindingExplanations()

public Explanations.ExplainedPolicy.Builder clearBindingExplanations()

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.v1.BindingExplanation binding_explanations = 4;

Returns
TypeDescription
Explanations.ExplainedPolicy.Builder

clearField(Descriptors.FieldDescriptor field)

public Explanations.ExplainedPolicy.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Explanations.ExplainedPolicy.Builder
Overrides

clearFullResourceName()

public Explanations.ExplainedPolicy.Builder clearFullResourceName()

The full resource name that identifies the resource. For example, //compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance. If the sender of the request does not have access to the policy, this field is omitted. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.

string full_resource_name = 2;

Returns
TypeDescription
Explanations.ExplainedPolicy.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Explanations.ExplainedPolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Explanations.ExplainedPolicy.Builder
Overrides

clearPolicy()

public Explanations.ExplainedPolicy.Builder clearPolicy()

The IAM policy attached to the resource. If the sender of the request does not have access to the policy, this field is empty.

.google.iam.v1.Policy policy = 3;

Returns
TypeDescription
Explanations.ExplainedPolicy.Builder

clearRelevance()

public Explanations.ExplainedPolicy.Builder clearRelevance()

The relevance of this policy to the overall determination in the TroubleshootIamPolicyResponse. If the sender of the request does not have access to the policy, this field is omitted.

.google.cloud.policytroubleshooter.v1.HeuristicRelevance relevance = 5;

Returns
TypeDescription
Explanations.ExplainedPolicy.Builder

This builder for chaining.

clone()

public Explanations.ExplainedPolicy.Builder clone()
Returns
TypeDescription
Explanations.ExplainedPolicy.Builder
Overrides

getAccess()

public Explanations.AccessState getAccess()

Indicates whether this policy provides the specified permission to the specified member for the specified resource. This field does not indicate whether the member actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the member actually has the permission, use the access field in the TroubleshootIamPolicyResponse.

.google.cloud.policytroubleshooter.v1.AccessState access = 1;

Returns
TypeDescription
Explanations.AccessState

The access.

getAccessValue()

public int getAccessValue()

Indicates whether this policy provides the specified permission to the specified member for the specified resource. This field does not indicate whether the member actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the member actually has the permission, use the access field in the TroubleshootIamPolicyResponse.

.google.cloud.policytroubleshooter.v1.AccessState access = 1;

Returns
TypeDescription
int

The enum numeric value on the wire for access.

getBindingExplanations(int index)

public Explanations.BindingExplanation getBindingExplanations(int index)

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.v1.BindingExplanation binding_explanations = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
Explanations.BindingExplanation

getBindingExplanationsBuilder(int index)

public Explanations.BindingExplanation.Builder getBindingExplanationsBuilder(int index)

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.v1.BindingExplanation binding_explanations = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
Explanations.BindingExplanation.Builder

getBindingExplanationsBuilderList()

public List<Explanations.BindingExplanation.Builder> getBindingExplanationsBuilderList()

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.v1.BindingExplanation binding_explanations = 4;

Returns
TypeDescription
List<Builder>

getBindingExplanationsCount()

public int getBindingExplanationsCount()

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.v1.BindingExplanation binding_explanations = 4;

Returns
TypeDescription
int

getBindingExplanationsList()

public List<Explanations.BindingExplanation> getBindingExplanationsList()

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.v1.BindingExplanation binding_explanations = 4;

Returns
TypeDescription
List<BindingExplanation>

getBindingExplanationsOrBuilder(int index)

public Explanations.BindingExplanationOrBuilder getBindingExplanationsOrBuilder(int index)

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.v1.BindingExplanation binding_explanations = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
Explanations.BindingExplanationOrBuilder

getBindingExplanationsOrBuilderList()

public List<? extends Explanations.BindingExplanationOrBuilder> getBindingExplanationsOrBuilderList()

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.v1.BindingExplanation binding_explanations = 4;

Returns
TypeDescription
List<? extends google.cloud.policytroubleshooter.v1.Explanations.BindingExplanationOrBuilder>

getDefaultInstanceForType()

public Explanations.ExplainedPolicy getDefaultInstanceForType()
Returns
TypeDescription
Explanations.ExplainedPolicy

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFullResourceName()

public String getFullResourceName()

The full resource name that identifies the resource. For example, //compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance. If the sender of the request does not have access to the policy, this field is omitted. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.

string full_resource_name = 2;

Returns
TypeDescription
String

The fullResourceName.

getFullResourceNameBytes()

public ByteString getFullResourceNameBytes()

The full resource name that identifies the resource. For example, //compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance. If the sender of the request does not have access to the policy, this field is omitted. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.

string full_resource_name = 2;

Returns
TypeDescription
ByteString

The bytes for fullResourceName.

getPolicy()

public Policy getPolicy()

The IAM policy attached to the resource. If the sender of the request does not have access to the policy, this field is empty.

.google.iam.v1.Policy policy = 3;

Returns
TypeDescription
com.google.iam.v1.Policy

The policy.

getPolicyBuilder()

public Policy.Builder getPolicyBuilder()

The IAM policy attached to the resource. If the sender of the request does not have access to the policy, this field is empty.

.google.iam.v1.Policy policy = 3;

Returns
TypeDescription
com.google.iam.v1.Policy.Builder

getPolicyOrBuilder()

public PolicyOrBuilder getPolicyOrBuilder()

The IAM policy attached to the resource. If the sender of the request does not have access to the policy, this field is empty.

.google.iam.v1.Policy policy = 3;

Returns
TypeDescription
com.google.iam.v1.PolicyOrBuilder

getRelevance()

public Explanations.HeuristicRelevance getRelevance()

The relevance of this policy to the overall determination in the TroubleshootIamPolicyResponse. If the sender of the request does not have access to the policy, this field is omitted.

.google.cloud.policytroubleshooter.v1.HeuristicRelevance relevance = 5;

Returns
TypeDescription
Explanations.HeuristicRelevance

The relevance.

getRelevanceValue()

public int getRelevanceValue()

The relevance of this policy to the overall determination in the TroubleshootIamPolicyResponse. If the sender of the request does not have access to the policy, this field is omitted.

.google.cloud.policytroubleshooter.v1.HeuristicRelevance relevance = 5;

Returns
TypeDescription
int

The enum numeric value on the wire for relevance.

hasPolicy()

public boolean hasPolicy()

The IAM policy attached to the resource. If the sender of the request does not have access to the policy, this field is empty.

.google.iam.v1.Policy policy = 3;

Returns
TypeDescription
boolean

Whether the policy field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Explanations.ExplainedPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Explanations.ExplainedPolicy.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Explanations.ExplainedPolicy.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Explanations.ExplainedPolicy.Builder
Overrides

mergeFrom(Explanations.ExplainedPolicy other)

public Explanations.ExplainedPolicy.Builder mergeFrom(Explanations.ExplainedPolicy other)
Parameter
NameDescription
otherExplanations.ExplainedPolicy
Returns
TypeDescription
Explanations.ExplainedPolicy.Builder

mergePolicy(Policy value)

public Explanations.ExplainedPolicy.Builder mergePolicy(Policy value)

The IAM policy attached to the resource. If the sender of the request does not have access to the policy, this field is empty.

.google.iam.v1.Policy policy = 3;

Parameter
NameDescription
valuecom.google.iam.v1.Policy
Returns
TypeDescription
Explanations.ExplainedPolicy.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Explanations.ExplainedPolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Explanations.ExplainedPolicy.Builder
Overrides

removeBindingExplanations(int index)

public Explanations.ExplainedPolicy.Builder removeBindingExplanations(int index)

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.v1.BindingExplanation binding_explanations = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
Explanations.ExplainedPolicy.Builder

setAccess(Explanations.AccessState value)

public Explanations.ExplainedPolicy.Builder setAccess(Explanations.AccessState value)

Indicates whether this policy provides the specified permission to the specified member for the specified resource. This field does not indicate whether the member actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the member actually has the permission, use the access field in the TroubleshootIamPolicyResponse.

.google.cloud.policytroubleshooter.v1.AccessState access = 1;

Parameter
NameDescription
valueExplanations.AccessState

The access to set.

Returns
TypeDescription
Explanations.ExplainedPolicy.Builder

This builder for chaining.

setAccessValue(int value)

public Explanations.ExplainedPolicy.Builder setAccessValue(int value)

Indicates whether this policy provides the specified permission to the specified member for the specified resource. This field does not indicate whether the member actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the member actually has the permission, use the access field in the TroubleshootIamPolicyResponse.

.google.cloud.policytroubleshooter.v1.AccessState access = 1;

Parameter
NameDescription
valueint

The enum numeric value on the wire for access to set.

Returns
TypeDescription
Explanations.ExplainedPolicy.Builder

This builder for chaining.

setBindingExplanations(int index, Explanations.BindingExplanation value)

public Explanations.ExplainedPolicy.Builder setBindingExplanations(int index, Explanations.BindingExplanation value)

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.v1.BindingExplanation binding_explanations = 4;

Parameters
NameDescription
indexint
valueExplanations.BindingExplanation
Returns
TypeDescription
Explanations.ExplainedPolicy.Builder

setBindingExplanations(int index, Explanations.BindingExplanation.Builder builderForValue)

public Explanations.ExplainedPolicy.Builder setBindingExplanations(int index, Explanations.BindingExplanation.Builder builderForValue)

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.v1.BindingExplanation binding_explanations = 4;

Parameters
NameDescription
indexint
builderForValueExplanations.BindingExplanation.Builder
Returns
TypeDescription
Explanations.ExplainedPolicy.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Explanations.ExplainedPolicy.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Explanations.ExplainedPolicy.Builder
Overrides

setFullResourceName(String value)

public Explanations.ExplainedPolicy.Builder setFullResourceName(String value)

The full resource name that identifies the resource. For example, //compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance. If the sender of the request does not have access to the policy, this field is omitted. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.

string full_resource_name = 2;

Parameter
NameDescription
valueString

The fullResourceName to set.

Returns
TypeDescription
Explanations.ExplainedPolicy.Builder

This builder for chaining.

setFullResourceNameBytes(ByteString value)

public Explanations.ExplainedPolicy.Builder setFullResourceNameBytes(ByteString value)

The full resource name that identifies the resource. For example, //compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance. If the sender of the request does not have access to the policy, this field is omitted. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.

string full_resource_name = 2;

Parameter
NameDescription
valueByteString

The bytes for fullResourceName to set.

Returns
TypeDescription
Explanations.ExplainedPolicy.Builder

This builder for chaining.

setPolicy(Policy value)

public Explanations.ExplainedPolicy.Builder setPolicy(Policy value)

The IAM policy attached to the resource. If the sender of the request does not have access to the policy, this field is empty.

.google.iam.v1.Policy policy = 3;

Parameter
NameDescription
valuecom.google.iam.v1.Policy
Returns
TypeDescription
Explanations.ExplainedPolicy.Builder

setPolicy(Policy.Builder builderForValue)

public Explanations.ExplainedPolicy.Builder setPolicy(Policy.Builder builderForValue)

The IAM policy attached to the resource. If the sender of the request does not have access to the policy, this field is empty.

.google.iam.v1.Policy policy = 3;

Parameter
NameDescription
builderForValuecom.google.iam.v1.Policy.Builder
Returns
TypeDescription
Explanations.ExplainedPolicy.Builder

setRelevance(Explanations.HeuristicRelevance value)

public Explanations.ExplainedPolicy.Builder setRelevance(Explanations.HeuristicRelevance value)

The relevance of this policy to the overall determination in the TroubleshootIamPolicyResponse. If the sender of the request does not have access to the policy, this field is omitted.

.google.cloud.policytroubleshooter.v1.HeuristicRelevance relevance = 5;

Parameter
NameDescription
valueExplanations.HeuristicRelevance

The relevance to set.

Returns
TypeDescription
Explanations.ExplainedPolicy.Builder

This builder for chaining.

setRelevanceValue(int value)

public Explanations.ExplainedPolicy.Builder setRelevanceValue(int value)

The relevance of this policy to the overall determination in the TroubleshootIamPolicyResponse. If the sender of the request does not have access to the policy, this field is omitted.

.google.cloud.policytroubleshooter.v1.HeuristicRelevance relevance = 5;

Parameter
NameDescription
valueint

The enum numeric value on the wire for relevance to set.

Returns
TypeDescription
Explanations.ExplainedPolicy.Builder

This builder for chaining.

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

public Explanations.ExplainedPolicy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Explanations.ExplainedPolicy.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Explanations.ExplainedPolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Explanations.ExplainedPolicy.Builder
Overrides