Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class protos.google.cloud.compute.v1.SecurityPolicyUserDefinedField (4.6.0)

Represents a SecurityPolicyUserDefinedField.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1.ISecurityPolicyUserDefinedField);

Constructs a new SecurityPolicyUserDefinedField.

Parameter
Name	Description
`properties`	`ISecurityPolicyUserDefinedField` Properties to set

Properties

_base

public _base?: "base";

SecurityPolicyUserDefinedField _base.

_mask

public _mask?: "mask";

SecurityPolicyUserDefinedField _mask.

_name

public _name?: "name";

SecurityPolicyUserDefinedField _name.

_offset

public _offset?: "offset";

SecurityPolicyUserDefinedField _offset.

_size

public _size?: "size";

SecurityPolicyUserDefinedField _size.

base

public base?: (string|null);

SecurityPolicyUserDefinedField base.

mask

public mask?: (string|null);

SecurityPolicyUserDefinedField mask.

name

public name?: (string|null);

SecurityPolicyUserDefinedField name.

offset

public offset?: (number|null);

SecurityPolicyUserDefinedField offset.

size

public size?: (number|null);

SecurityPolicyUserDefinedField size.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.ISecurityPolicyUserDefinedField): google.cloud.compute.v1.SecurityPolicyUserDefinedField;

Creates a new SecurityPolicyUserDefinedField instance using the specified properties.

Parameter
Name	Description
`properties`	`ISecurityPolicyUserDefinedField` Properties to set

Returns
Type	Description
`SecurityPolicyUserDefinedField`	SecurityPolicyUserDefinedField instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1.SecurityPolicyUserDefinedField;

Decodes a SecurityPolicyUserDefinedField 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
`SecurityPolicyUserDefinedField`	SecurityPolicyUserDefinedField

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.SecurityPolicyUserDefinedField;

Decodes a SecurityPolicyUserDefinedField message from the specified reader or buffer, length delimited.

Parameter
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`SecurityPolicyUserDefinedField`	SecurityPolicyUserDefinedField

encode(message, writer)

public static encode(message: google.cloud.compute.v1.ISecurityPolicyUserDefinedField, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SecurityPolicyUserDefinedField message. Does not implicitly messages.

Parameters
Name	Description
`message`	`ISecurityPolicyUserDefinedField` SecurityPolicyUserDefinedField 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.compute.v1.ISecurityPolicyUserDefinedField, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SecurityPolicyUserDefinedField message, length delimited. Does not implicitly messages.

Parameters
Name	Description
`message`	`ISecurityPolicyUserDefinedField` SecurityPolicyUserDefinedField 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.compute.v1.SecurityPolicyUserDefinedField;

Creates a SecurityPolicyUserDefinedField 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
`SecurityPolicyUserDefinedField`	SecurityPolicyUserDefinedField

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for SecurityPolicyUserDefinedField

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 SecurityPolicyUserDefinedField to JSON.

Returns
Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

public static toObject(message: google.cloud.compute.v1.SecurityPolicyUserDefinedField, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a SecurityPolicyUserDefinedField message. Also converts values to other types if specified.

Parameters
Name	Description
`message`	`SecurityPolicyUserDefinedField` SecurityPolicyUserDefinedField
`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 SecurityPolicyUserDefinedField message.

Parameter
Name	Description
`message`	`{ [k: string]: any }` Plain object to verify

Returns
Type	Description
`(string\|null)`	`null` if valid, otherwise the reason why it is not