Class protos.google.cloud.networkmanagement.v1beta1.EffectiveVpcFlowLogsConfig (5.2.0)

Represents an EffectiveVpcFlowLogsConfig.

Package

@google-cloud/network-management

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.networkmanagement.v1beta1.IEffectiveVpcFlowLogsConfig);

Constructs a new EffectiveVpcFlowLogsConfig.

Parameter
Name Description
properties IEffectiveVpcFlowLogsConfig

Properties to set

Properties

aggregationInterval

public aggregationInterval?: (google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.AggregationInterval|keyof typeof google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.AggregationInterval|null);

EffectiveVpcFlowLogsConfig aggregationInterval.

crossProjectMetadata

public crossProjectMetadata?: (google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.CrossProjectMetadata|keyof typeof google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.CrossProjectMetadata|null);

EffectiveVpcFlowLogsConfig crossProjectMetadata.

filterExpr

public filterExpr?: (string|null);

EffectiveVpcFlowLogsConfig filterExpr.

flowSampling

public flowSampling?: (number|null);

EffectiveVpcFlowLogsConfig flowSampling.

interconnectAttachment

public interconnectAttachment?: (string|null);

EffectiveVpcFlowLogsConfig interconnectAttachment.

metadata

public metadata?: (google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.Metadata|keyof typeof google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.Metadata|null);

EffectiveVpcFlowLogsConfig metadata.

metadataFields

public metadataFields: string[];

EffectiveVpcFlowLogsConfig metadataFields.

name

public name: string;

EffectiveVpcFlowLogsConfig name.

network

public network?: (string|null);

EffectiveVpcFlowLogsConfig network.

scope

public scope?: (google.cloud.networkmanagement.v1beta1.EffectiveVpcFlowLogsConfig.Scope|keyof typeof google.cloud.networkmanagement.v1beta1.EffectiveVpcFlowLogsConfig.Scope|null);

EffectiveVpcFlowLogsConfig scope.

state

public state?: (google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.State|keyof typeof google.cloud.networkmanagement.v1beta1.VpcFlowLogsConfig.State|null);

EffectiveVpcFlowLogsConfig state.

subnet

public subnet?: (string|null);

EffectiveVpcFlowLogsConfig subnet.

targetResource

public targetResource?: ("network"|"subnet"|"interconnectAttachment"|"vpnTunnel");

EffectiveVpcFlowLogsConfig targetResource.

vpnTunnel

public vpnTunnel?: (string|null);

EffectiveVpcFlowLogsConfig vpnTunnel.

Methods

create(properties)

public static create(properties?: google.cloud.networkmanagement.v1beta1.IEffectiveVpcFlowLogsConfig): google.cloud.networkmanagement.v1beta1.EffectiveVpcFlowLogsConfig;

Creates a new EffectiveVpcFlowLogsConfig instance using the specified properties.

Parameter
Name Description
properties IEffectiveVpcFlowLogsConfig

Properties to set

Returns
Type Description
EffectiveVpcFlowLogsConfig

EffectiveVpcFlowLogsConfig instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.networkmanagement.v1beta1.EffectiveVpcFlowLogsConfig;

Decodes an EffectiveVpcFlowLogsConfig 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
EffectiveVpcFlowLogsConfig

EffectiveVpcFlowLogsConfig

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.networkmanagement.v1beta1.EffectiveVpcFlowLogsConfig;

Decodes an EffectiveVpcFlowLogsConfig message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
EffectiveVpcFlowLogsConfig

EffectiveVpcFlowLogsConfig

encode(message, writer)

public static encode(message: google.cloud.networkmanagement.v1beta1.IEffectiveVpcFlowLogsConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified EffectiveVpcFlowLogsConfig message. Does not implicitly messages.

Parameters
Name Description
message IEffectiveVpcFlowLogsConfig

EffectiveVpcFlowLogsConfig 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.networkmanagement.v1beta1.IEffectiveVpcFlowLogsConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IEffectiveVpcFlowLogsConfig

EffectiveVpcFlowLogsConfig 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.networkmanagement.v1beta1.EffectiveVpcFlowLogsConfig;

Creates an EffectiveVpcFlowLogsConfig 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
EffectiveVpcFlowLogsConfig

EffectiveVpcFlowLogsConfig

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for EffectiveVpcFlowLogsConfig

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

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message EffectiveVpcFlowLogsConfig

EffectiveVpcFlowLogsConfig

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 an EffectiveVpcFlowLogsConfig 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