public interface OrgPolicyViolationsPreviewOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getCreateTime()
public abstract Timestamp getCreateTime()
Output only. Time when this OrgPolicyViolationsPreview
was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp |
The createTime. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Time when this OrgPolicyViolationsPreview
was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getCustomConstraints(int index)
public abstract String getCustomConstraints(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) = { ... }
Parameter | |
---|---|
Name | Description |
index |
int The index of the element to return. |
Returns | |
---|---|
Type | Description |
String |
The customConstraints at the given index. |
getCustomConstraintsBytes(int index)
public abstract 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) = { ... }
Parameter | |
---|---|
Name | Description |
index |
int The index of the value to return. |
Returns | |
---|---|
Type | Description |
ByteString |
The bytes of the customConstraints at the given index. |
getCustomConstraintsCount()
public abstract 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 | |
---|---|
Type | Description |
int |
The count of customConstraints. |
getCustomConstraintsList()
public abstract List<String> 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 | |
---|---|
Type | Description |
List<String> |
A list containing the customConstraints. |
getName()
public abstract 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 | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public abstract 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 | |
---|---|
Type | Description |
ByteString |
The bytes for name. |
getOverlay()
public abstract OrgPolicyOverlay getOverlay()
Required. The proposed changes we are previewing violations for.
.google.cloud.policysimulator.v1.OrgPolicyOverlay overlay = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
OrgPolicyOverlay |
The overlay. |
getOverlayOrBuilder()
public abstract OrgPolicyOverlayOrBuilder getOverlayOrBuilder()
Required. The proposed changes we are previewing violations for.
.google.cloud.policysimulator.v1.OrgPolicyOverlay overlay = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
OrgPolicyOverlayOrBuilder |
getResourceCounts()
public abstract 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 | |
---|---|
Type | Description |
OrgPolicyViolationsPreview.ResourceCounts |
The resourceCounts. |
getResourceCountsOrBuilder()
public abstract 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];
Returns | |
---|---|
Type | Description |
OrgPolicyViolationsPreview.ResourceCountsOrBuilder |
getState()
public abstract PreviewState getState()
Output only. The state of the OrgPolicyViolationsPreview
.
.google.cloud.policysimulator.v1.PreviewState state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
PreviewState |
The state. |
getStateValue()
public abstract int getStateValue()
Output only. The state of the OrgPolicyViolationsPreview
.
.google.cloud.policysimulator.v1.PreviewState state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for state. |
getViolationsCount()
public abstract int getViolationsCount()
Output only. The number of [OrgPolicyViolations][] in this
OrgPolicyViolationsPreview
. This count may differ from
resource_summary.noncompliant_count
because each
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 | |
---|---|
Type | Description |
int |
The violationsCount. |
hasCreateTime()
public abstract boolean hasCreateTime()
Output only. Time when this OrgPolicyViolationsPreview
was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
Whether the createTime field is set. |
hasOverlay()
public abstract boolean hasOverlay()
Required. The proposed changes we are previewing violations for.
.google.cloud.policysimulator.v1.OrgPolicyOverlay overlay = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
boolean |
Whether the overlay field is set. |
hasResourceCounts()
public abstract 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 | |
---|---|
Type | Description |
boolean |
Whether the resourceCounts field is set. |