Constructor
new Constraint(propertiesopt)
Constructs a new Constraint.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.orgpolicy.v2.IConstraint |
<optional> |
Properties to set |
- Implements:
-
- IConstraint
Classes
Members
booleanConstraint
Constraint booleanConstraint.
constraintDefault
Constraint constraintDefault.
constraintType
Constraint constraintType.
description
Constraint description.
displayName
Constraint displayName.
listConstraint
Constraint listConstraint.
name
Constraint name.
supportsDryRun
Constraint supportsDryRun.
ConstraintDefault
ConstraintDefault enum.
Properties:
| Name | Type | Description |
|---|---|---|
CONSTRAINT_DEFAULT_UNSPECIFIED |
number |
CONSTRAINT_DEFAULT_UNSPECIFIED value |
ALLOW |
number |
ALLOW value |
DENY |
number |
DENY value |
Methods
toJSON() → {Object.<string, *>}
Converts this Constraint to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.orgpolicy.v2.Constraint}
Creates a new Constraint instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.orgpolicy.v2.IConstraint |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.orgpolicy.v2.Constraint |
Constraint instance |
(static) decode(reader, lengthopt) → {google.cloud.orgpolicy.v2.Constraint}
Decodes a Constraint message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.cloud.orgpolicy.v2.Constraint |
Constraint |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.cloud.orgpolicy.v2.Constraint}
Decodes a Constraint message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.cloud.orgpolicy.v2.Constraint |
Constraint |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified Constraint message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.orgpolicy.v2.IConstraint |
Constraint message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified Constraint message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.orgpolicy.v2.IConstraint |
Constraint message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.cloud.orgpolicy.v2.Constraint}
Creates a Constraint message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.cloud.orgpolicy.v2.Constraint |
Constraint |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Constraint
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a Constraint message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.orgpolicy.v2.Constraint |
Constraint |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a Constraint message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|