Class OrgPolicyViolationsPreview
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.policysimulator.v1.OrgPolicyViolationsPreview
- All Implemented Interfaces:
OrgPolicyViolationsPreviewOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class OrgPolicyViolationsPreview
extends com.google.protobuf.GeneratedMessage
implements OrgPolicyViolationsPreviewOrBuilder
OrgPolicyViolationsPreview is a resource providing a preview of the violations that will exist if an OrgPolicy change is made. The list of violations are modeled as child resources and retrieved via a [ListOrgPolicyViolations][] API call. There are potentially more [OrgPolicyViolations][] than could fit in an embedded field. Thus, the use of a child resource instead of a field.Protobuf type
google.cloud.policysimulator.v1.OrgPolicyViolationsPreview- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classOrgPolicyViolationsPreview is a resource providing a preview of the violations that will exist if an OrgPolicy change is made.static final classA summary of the state of all resources scanned for compliance with the changed OrgPolicy.static interfaceNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleancom.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.getCustomConstraints(int index) Output only.com.google.protobuf.ByteStringgetCustomConstraintsBytes(int index) Output only.intOutput only.com.google.protobuf.ProtocolStringListOutput only.static OrgPolicyViolationsPreviewstatic final com.google.protobuf.Descriptors.DescriptorgetName()Output only.com.google.protobuf.ByteStringOutput only.Required.Required.com.google.protobuf.Parser<OrgPolicyViolationsPreview>Output only.Output only.intgetState()Output only.intOutput only.intOutput only.booleanOutput only.inthashCode()booleanRequired.booleanOutput only.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleannewBuilder(OrgPolicyViolationsPreview prototype) protected OrgPolicyViolationsPreview.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static OrgPolicyViolationsPreviewparseDelimitedFrom(InputStream input) static OrgPolicyViolationsPreviewparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static OrgPolicyViolationsPreviewparseFrom(byte[] data) static OrgPolicyViolationsPreviewparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static OrgPolicyViolationsPreviewparseFrom(com.google.protobuf.ByteString data) static OrgPolicyViolationsPreviewparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static OrgPolicyViolationsPreviewparseFrom(com.google.protobuf.CodedInputStream input) static OrgPolicyViolationsPreviewparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static OrgPolicyViolationsPreviewparseFrom(InputStream input) static OrgPolicyViolationsPreviewparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static OrgPolicyViolationsPreviewparseFrom(ByteBuffer data) static OrgPolicyViolationsPreviewparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<OrgPolicyViolationsPreview>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER- See Also:
-
OVERLAY_FIELD_NUMBER
public static final int OVERLAY_FIELD_NUMBER- See Also:
-
VIOLATIONS_COUNT_FIELD_NUMBER
public static final int VIOLATIONS_COUNT_FIELD_NUMBER- See Also:
-
RESOURCE_COUNTS_FIELD_NUMBER
public static final int RESOURCE_COUNTS_FIELD_NUMBER- See Also:
-
CUSTOM_CONSTRAINTS_FIELD_NUMBER
public static final int CUSTOM_CONSTRAINTS_FIELD_NUMBER- See Also:
-
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
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];- Specified by:
getNamein interfaceOrgPolicyViolationsPreviewOrBuilder- Returns:
- The name.
-
getNameBytes
public 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];- Specified by:
getNameBytesin interfaceOrgPolicyViolationsPreviewOrBuilder- Returns:
- The bytes for name.
-
getStateValue
public int getStateValue()Output only. The state of the `OrgPolicyViolationsPreview`.
.google.cloud.policysimulator.v1.PreviewState state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStateValuein interfaceOrgPolicyViolationsPreviewOrBuilder- Returns:
- The enum numeric value on the wire for state.
-
getState
Output only. The state of the `OrgPolicyViolationsPreview`.
.google.cloud.policysimulator.v1.PreviewState state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStatein interfaceOrgPolicyViolationsPreviewOrBuilder- Returns:
- The state.
-
hasOverlay
public boolean hasOverlay()Required. The proposed changes we are previewing violations for.
.google.cloud.policysimulator.v1.OrgPolicyOverlay overlay = 3 [(.google.api.field_behavior) = REQUIRED];- Specified by:
hasOverlayin interfaceOrgPolicyViolationsPreviewOrBuilder- Returns:
- Whether the overlay field is set.
-
getOverlay
Required. The proposed changes we are previewing violations for.
.google.cloud.policysimulator.v1.OrgPolicyOverlay overlay = 3 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getOverlayin interfaceOrgPolicyViolationsPreviewOrBuilder- Returns:
- The overlay.
-
getOverlayOrBuilder
Required. The proposed changes we are previewing violations for.
.google.cloud.policysimulator.v1.OrgPolicyOverlay overlay = 3 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getOverlayOrBuilderin interfaceOrgPolicyViolationsPreviewOrBuilder
-
getViolationsCount
public 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];- Specified by:
getViolationsCountin interfaceOrgPolicyViolationsPreviewOrBuilder- Returns:
- The violationsCount.
-
hasResourceCounts
public 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];- Specified by:
hasResourceCountsin interfaceOrgPolicyViolationsPreviewOrBuilder- Returns:
- Whether the resourceCounts field is set.
-
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];- Specified by:
getResourceCountsin interfaceOrgPolicyViolationsPreviewOrBuilder- Returns:
- The resourceCounts.
-
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];- Specified by:
getResourceCountsOrBuilderin interfaceOrgPolicyViolationsPreviewOrBuilder
-
getCustomConstraintsList
public com.google.protobuf.ProtocolStringList 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) = { ... }- Specified by:
getCustomConstraintsListin interfaceOrgPolicyViolationsPreviewOrBuilder- Returns:
- A list containing the customConstraints.
-
getCustomConstraintsCount
public 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) = { ... }- Specified by:
getCustomConstraintsCountin interfaceOrgPolicyViolationsPreviewOrBuilder- 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) = { ... }- Specified by:
getCustomConstraintsin interfaceOrgPolicyViolationsPreviewOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The customConstraints at the given index.
-
getCustomConstraintsBytes
public 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) = { ... }- Specified by:
getCustomConstraintsBytesin interfaceOrgPolicyViolationsPreviewOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the customConstraints at the given index.
-
hasCreateTime
public boolean hasCreateTime()Output only. Time when this `OrgPolicyViolationsPreview` was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasCreateTimein interfaceOrgPolicyViolationsPreviewOrBuilder- Returns:
- Whether the createTime field is set.
-
getCreateTime
public 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];- Specified by:
getCreateTimein interfaceOrgPolicyViolationsPreviewOrBuilder- Returns:
- The createTime.
-
getCreateTimeOrBuilder
public 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];- Specified by:
getCreateTimeOrBuilderin interfaceOrgPolicyViolationsPreviewOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static OrgPolicyViolationsPreview parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static OrgPolicyViolationsPreview parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static OrgPolicyViolationsPreview parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static OrgPolicyViolationsPreview parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static OrgPolicyViolationsPreview parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static OrgPolicyViolationsPreview parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static OrgPolicyViolationsPreview parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static OrgPolicyViolationsPreview parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static OrgPolicyViolationsPreview parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static OrgPolicyViolationsPreview parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected OrgPolicyViolationsPreview.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-