Package com.google.cloud.orgpolicy.v2

Interface PolicySpecOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PolicySpec, PolicySpec.Builder
@Generated public interface PolicySpecOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getEtag()
    An opaque tag indicating the current version of the policySpec, used for concurrency control.
    com.google.protobuf.ByteString
    getEtagBytes()
    An opaque tag indicating the current version of the policySpec, used for concurrency control.
    boolean
    getInheritFromParent()
    Determines the inheritance behavior for this policy.
    boolean
    getReset()
    Ignores policies set above this resource and restores the `constraint_default` enforcement behavior of the specific constraint at this resource.
    PolicySpec.PolicyRule
    getRules(int index)
    In policies for boolean constraints, the following requirements apply: - There must be one and only one policy rule where condition is unset
    int
    getRulesCount()
    In policies for boolean constraints, the following requirements apply: - There must be one and only one policy rule where condition is unset
    List<PolicySpec.PolicyRule>
    getRulesList()
    In policies for boolean constraints, the following requirements apply: - There must be one and only one policy rule where condition is unset
    PolicySpec.PolicyRuleOrBuilder
    getRulesOrBuilder(int index)
    In policies for boolean constraints, the following requirements apply: - There must be one and only one policy rule where condition is unset
    List<? extends PolicySpec.PolicyRuleOrBuilder>
    getRulesOrBuilderList()
    In policies for boolean constraints, the following requirements apply: - There must be one and only one policy rule where condition is unset
    com.google.protobuf.Timestamp
    getUpdateTime()
    Output only.
    com.google.protobuf.TimestampOrBuilder
    getUpdateTimeOrBuilder()
    Output only.
    boolean
    hasUpdateTime()
    Output only.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getEtag

      String getEtag()
       An opaque tag indicating the current version of the policySpec, used for
 concurrency control.

 This field is ignored if used in a `CreatePolicy` request.

 When the policy is returned from either a `GetPolicy` or a
 `ListPolicies` request, this `etag` indicates the version of the
 current policySpec to use when executing a read-modify-write loop.

 When the policy is returned from a `GetEffectivePolicy` request, the
 `etag` will be unset.
      string etag = 1;
      Returns:
      The etag.

    • getEtagBytes

      com.google.protobuf.ByteString getEtagBytes()
       An opaque tag indicating the current version of the policySpec, used for
 concurrency control.

 This field is ignored if used in a `CreatePolicy` request.

 When the policy is returned from either a `GetPolicy` or a
 `ListPolicies` request, this `etag` indicates the version of the
 current policySpec to use when executing a read-modify-write loop.

 When the policy is returned from a `GetEffectivePolicy` request, the
 `etag` will be unset.
      string etag = 1;
      Returns:
      The bytes for etag.

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. The time stamp this was previously updated. This
 represents the last time a call to `CreatePolicy` or `UpdatePolicy` was
 made for that policy.
      .google.protobuf.Timestamp update_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. The time stamp this was previously updated. This
 represents the last time a call to `CreatePolicy` or `UpdatePolicy` was
 made for that policy.
      .google.protobuf.Timestamp update_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The time stamp this was previously updated. This
 represents the last time a call to `CreatePolicy` or `UpdatePolicy` was
 made for that policy.
      .google.protobuf.Timestamp update_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getRulesList

      List<PolicySpec.PolicyRule> getRulesList()
       In policies for boolean constraints, the following requirements apply:

 - There must be one and only one policy rule where condition is unset.
 - Boolean policy rules with conditions must set `enforced` to the
 opposite of the policy rule without a condition.
 - During policy evaluation, policy rules with conditions that are
 true for a target resource take precedence.
      repeated .google.cloud.orgpolicy.v2.PolicySpec.PolicyRule rules = 3;

    • getRules

      PolicySpec.PolicyRule getRules(int index)
       In policies for boolean constraints, the following requirements apply:

 - There must be one and only one policy rule where condition is unset.
 - Boolean policy rules with conditions must set `enforced` to the
 opposite of the policy rule without a condition.
 - During policy evaluation, policy rules with conditions that are
 true for a target resource take precedence.
      repeated .google.cloud.orgpolicy.v2.PolicySpec.PolicyRule rules = 3;

    • getRulesCount

      int getRulesCount()
       In policies for boolean constraints, the following requirements apply:

 - There must be one and only one policy rule where condition is unset.
 - Boolean policy rules with conditions must set `enforced` to the
 opposite of the policy rule without a condition.
 - During policy evaluation, policy rules with conditions that are
 true for a target resource take precedence.
      repeated .google.cloud.orgpolicy.v2.PolicySpec.PolicyRule rules = 3;

    • getRulesOrBuilderList

      List<? extends PolicySpec.PolicyRuleOrBuilder> getRulesOrBuilderList()
       In policies for boolean constraints, the following requirements apply:

 - There must be one and only one policy rule where condition is unset.
 - Boolean policy rules with conditions must set `enforced` to the
 opposite of the policy rule without a condition.
 - During policy evaluation, policy rules with conditions that are
 true for a target resource take precedence.
      repeated .google.cloud.orgpolicy.v2.PolicySpec.PolicyRule rules = 3;

    • getRulesOrBuilder

      PolicySpec.PolicyRuleOrBuilder getRulesOrBuilder(int index)
       In policies for boolean constraints, the following requirements apply:

 - There must be one and only one policy rule where condition is unset.
 - Boolean policy rules with conditions must set `enforced` to the
 opposite of the policy rule without a condition.
 - During policy evaluation, policy rules with conditions that are
 true for a target resource take precedence.
      repeated .google.cloud.orgpolicy.v2.PolicySpec.PolicyRule rules = 3;

    • getInheritFromParent

      boolean getInheritFromParent()
       Determines the inheritance behavior for this policy.

 If `inherit_from_parent` is true, policy rules set higher up in the
 hierarchy (up to the closest root) are inherited and present in the
 effective policy. If it is false, then no rules are inherited, and this
 policy becomes the new root for evaluation.
 This field can be set only for policies which configure list constraints.
      bool inherit_from_parent = 4;
      Returns:
      The inheritFromParent.

    • getReset

      boolean getReset()
       Ignores policies set above this resource and restores the
 `constraint_default` enforcement behavior of the specific constraint at
 this resource.
 This field can be set in policies for either list or boolean
 constraints. If set, `rules` must be empty and `inherit_from_parent`
 must be set to false.
      bool reset = 5;
      Returns:
      The reset.