Interface OrgPolicyViolationsPreviewOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
OrgPolicyViolationsPreview,OrgPolicyViolationsPreview.Builder
@Generated
public interface OrgPolicyViolationsPreviewOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptioncom.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.getCustomConstraints(int index) Output only.com.google.protobuf.ByteStringgetCustomConstraintsBytes(int index) Output only.intOutput only.Output only.getName()Output only.com.google.protobuf.ByteStringOutput only.Required.Required.Output only.Output only.getState()Output only.intOutput only.intOutput only.booleanOutput only.booleanRequired.booleanOutput only.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getName
String getName()Output only. The resource name of the `OrgPolicyViolationsPreview`. It has the following format: `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` Example: `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f`string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()Output only. The resource name of the `OrgPolicyViolationsPreview`. It has the following format: `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` Example: `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f`string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The bytes for name.
-
getStateValue
int getStateValue()Output only. The state of the `OrgPolicyViolationsPreview`.
.google.cloud.policysimulator.v1.PreviewState state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The enum numeric value on the wire for state.
-
getState
PreviewState getState()Output only. The state of the `OrgPolicyViolationsPreview`.
.google.cloud.policysimulator.v1.PreviewState state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The state.
-
hasOverlay
boolean hasOverlay()Required. The proposed changes we are previewing violations for.
.google.cloud.policysimulator.v1.OrgPolicyOverlay overlay = 3 [(.google.api.field_behavior) = REQUIRED];- Returns:
- Whether the overlay field is set.
-
getOverlay
OrgPolicyOverlay getOverlay()Required. The proposed changes we are previewing violations for.
.google.cloud.policysimulator.v1.OrgPolicyOverlay overlay = 3 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The overlay.
-
getOverlayOrBuilder
OrgPolicyOverlayOrBuilder getOverlayOrBuilder()Required. The proposed changes we are previewing violations for.
.google.cloud.policysimulator.v1.OrgPolicyOverlay overlay = 3 [(.google.api.field_behavior) = REQUIRED]; -
getViolationsCount
int getViolationsCount()Output only. The number of [OrgPolicyViolations][] in this `OrgPolicyViolationsPreview`. This count may differ from `resource_summary.noncompliant_count` because each [OrgPolicyViolation][google.cloud.policysimulator.v1.OrgPolicyViolation] is specific to a resource **and** constraint. If there are multiple constraints being evaluated (i.e. multiple policies in the overlay), a single resource may violate multiple constraints.
int32 violations_count = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The violationsCount.
-
hasResourceCounts
boolean hasResourceCounts()Output only. A summary of the state of all resources scanned for compliance with the changed OrgPolicy.
.google.cloud.policysimulator.v1.OrgPolicyViolationsPreview.ResourceCounts resource_counts = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the resourceCounts field is set.
-
getResourceCounts
OrgPolicyViolationsPreview.ResourceCounts getResourceCounts()Output only. A summary of the state of all resources scanned for compliance with the changed OrgPolicy.
.google.cloud.policysimulator.v1.OrgPolicyViolationsPreview.ResourceCounts resource_counts = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The resourceCounts.
-
getResourceCountsOrBuilder
OrgPolicyViolationsPreview.ResourceCountsOrBuilder getResourceCountsOrBuilder()Output only. A summary of the state of all resources scanned for compliance with the changed OrgPolicy.
.google.cloud.policysimulator.v1.OrgPolicyViolationsPreview.ResourceCounts resource_counts = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getCustomConstraintsList
Output only. The names of the constraints against which all `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only contains `PolicyOverlay` then it contains the name of the configured custom constraint, applicable to the specified policies. Otherwise it contains the name of the constraint specified in `CustomConstraintOverlay`. Format: `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms`repeated string custom_constraints = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Returns:
- A list containing the customConstraints.
-
getCustomConstraintsCount
int getCustomConstraintsCount()Output only. The names of the constraints against which all `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only contains `PolicyOverlay` then it contains the name of the configured custom constraint, applicable to the specified policies. Otherwise it contains the name of the constraint specified in `CustomConstraintOverlay`. Format: `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms`repeated string custom_constraints = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Returns:
- The count of customConstraints.
-
getCustomConstraints
Output only. The names of the constraints against which all `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only contains `PolicyOverlay` then it contains the name of the configured custom constraint, applicable to the specified policies. Otherwise it contains the name of the constraint specified in `CustomConstraintOverlay`. Format: `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms`repeated string custom_constraints = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Parameters:
index- The index of the element to return.- Returns:
- The customConstraints at the given index.
-
getCustomConstraintsBytes
com.google.protobuf.ByteString getCustomConstraintsBytes(int index) Output only. The names of the constraints against which all `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only contains `PolicyOverlay` then it contains the name of the configured custom constraint, applicable to the specified policies. Otherwise it contains the name of the constraint specified in `CustomConstraintOverlay`. Format: `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms`repeated string custom_constraints = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the customConstraints at the given index.
-
hasCreateTime
boolean hasCreateTime()Output only. Time when this `OrgPolicyViolationsPreview` was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the createTime field is set.
-
getCreateTime
com.google.protobuf.Timestamp getCreateTime()Output only. Time when this `OrgPolicyViolationsPreview` was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The createTime.
-
getCreateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()Output only. Time when this `OrgPolicyViolationsPreview` was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
-