com.google.api.services.cloudkms.v1.model

Class Rule

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.cloudkms.v1.model.Rule

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class Rule
extends com.google.api.client.json.GenericJson

A rule to be applied in a Policy.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Cloud Key Management Service (KMS) API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Rule()

Method Summary

Methods

Modifier and Type	Method and Description
Rule	clone()
java.lang.String	getAction() Required
java.util.List<Condition>	getConditions() Additional restrictions that must be met
java.lang.String	getDescription() Human-readable description of the rule.
java.util.List<java.lang.String>	getIn() If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
java.util.List<LogConfig>	getLogConfig() The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
java.util.List<java.lang.String>	getNotIn() If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
java.util.List<java.lang.String>	getPermissions() A permission is a string of form '..' (e.g., 'storage.buckets.list').
Rule	set(java.lang.String fieldName, java.lang.Object value)
Rule	setAction(java.lang.String action) Required
Rule	setConditions(java.util.List<Condition> conditions) Additional restrictions that must be met
Rule	setDescription(java.lang.String description) Human-readable description of the rule.
Rule	setIn(java.util.List<java.lang.String> in) If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
Rule	setLogConfig(java.util.List<LogConfig> logConfig) The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
Rule	setNotIn(java.util.List<java.lang.String> notIn) If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
Rule	setPermissions(java.util.List<java.lang.String> permissions) A permission is a string of form '..' (e.g., 'storage.buckets.list').

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Rule

public Rule()

Method Detail

getAction

public java.lang.String getAction()

Required

Returns:

value or null for none

setAction

public Rule setAction(java.lang.String action)

Required

Parameters:

action - action or null for none

getConditions

public java.util.List<Condition> getConditions()

Additional restrictions that must be met

Returns:

value or null for none

setConditions

public Rule setConditions(java.util.List<Condition> conditions)

Additional restrictions that must be met

Parameters:

conditions - conditions or null for none

getDescription

public java.lang.String getDescription()

Human-readable description of the rule.

Returns:

value or null for none

setDescription

public Rule setDescription(java.lang.String description)

Human-readable description of the rule.

Parameters:

description - description or null for none

getIn

public java.util.List<java.lang.String> getIn()

If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

Returns:

value or null for none

setIn

public Rule setIn(java.util.List<java.lang.String> in)

If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

Parameters:

in - in or null for none

getLogConfig

public java.util.List<LogConfig> getLogConfig()

The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

Returns:

value or null for none

setLogConfig

public Rule setLogConfig(java.util.List<LogConfig> logConfig)

The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

Parameters:

logConfig - logConfig or null for none

getNotIn

public java.util.List<java.lang.String> getNotIn()

If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. The format for in and not_in entries is the same as for members in a Binding (see google/iam/v1/policy.proto).

Returns:

value or null for none

setNotIn

public Rule setNotIn(java.util.List<java.lang.String> notIn)

If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. The format for in and not_in entries is the same as for members in a Binding (see google/iam/v1/policy.proto).

Parameters:

notIn - notIn or null for none

getPermissions

public java.util.List<java.lang.String> getPermissions()

A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

Returns:

value or null for none

setPermissions

public Rule setPermissions(java.util.List<java.lang.String> permissions)

A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

Parameters:

permissions - permissions or null for none

set

public Rule set(java.lang.String fieldName,
       java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Rule clone()

Overrides:

clone in class com.google.api.client.json.GenericJson