Represents a ListPolicy.
Package
@google-cloud/assetConstructors
(constructor)(properties)
constructor(properties?: google.cloud.orgpolicy.v1.Policy.IListPolicy);
Constructs a new ListPolicy.
Parameter | |
---|---|
Name | Description |
properties |
IListPolicy
Properties to set |
Properties
allowedValues
public allowedValues: string[];
ListPolicy allowedValues.
allValues
public allValues: (google.cloud.orgpolicy.v1.Policy.ListPolicy.AllValues|keyof typeof google.cloud.orgpolicy.v1.Policy.ListPolicy.AllValues);
ListPolicy allValues.
deniedValues
public deniedValues: string[];
ListPolicy deniedValues.
inheritFromParent
public inheritFromParent: boolean;
ListPolicy inheritFromParent.
suggestedValue
public suggestedValue: string;
ListPolicy suggestedValue.
Methods
create(properties)
public static create(properties?: google.cloud.orgpolicy.v1.Policy.IListPolicy): google.cloud.orgpolicy.v1.Policy.ListPolicy;
Creates a new ListPolicy instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IListPolicy
Properties to set |
Returns | |
---|---|
Type | Description |
ListPolicy | ListPolicy instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.orgpolicy.v1.Policy.ListPolicy;
Decodes a ListPolicy message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
ListPolicy | ListPolicy |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.orgpolicy.v1.Policy.ListPolicy;
Decodes a ListPolicy message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
ListPolicy | ListPolicy |
encode(message, writer)
public static encode(message: google.cloud.orgpolicy.v1.Policy.IListPolicy, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified ListPolicy message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IListPolicy
ListPolicy message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.orgpolicy.v1.Policy.IListPolicy, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified ListPolicy message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IListPolicy
ListPolicy message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.orgpolicy.v1.Policy.ListPolicy;
Creates a ListPolicy message from a plain object. Also converts values to their respective internal types.
Parameter | |
---|---|
Name | Description |
object |
{ [k: string]: any }
Plain object |
Returns | |
---|---|
Type | Description |
ListPolicy | ListPolicy |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for ListPolicy
Parameter | |
---|---|
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns | |
---|---|
Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this ListPolicy to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.orgpolicy.v1.Policy.ListPolicy, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a ListPolicy message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
ListPolicy
ListPolicy |
options |
$protobuf.IConversionOptions
Conversion options |
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a ListPolicy message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|