Network Services v1 API - Class WasmPluginName (1.3.0)

public sealed class WasmPluginName : IResourceName, IEquatable<WasmPluginName>

Reference documentation and code samples for the Network Services v1 API class WasmPluginName.

Resource name for the WasmPlugin resource.

Inheritance

object > WasmPluginName

Namespace

Google.Cloud.NetworkServices.V1

Assembly

Google.Cloud.NetworkServices.V1.dll

Constructors

WasmPluginName(string, string, string)

public WasmPluginName(string projectId, string locationId, string wasmPluginId)

Constructs a new instance of a WasmPluginName class from the component parts of pattern projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

wasmPluginId string

The WasmPlugin ID. Must not be null or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type Description
bool

LocationId

public string LocationId { get; }

The Location ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Type

public WasmPluginName.ResourceNameType Type { get; }

The WasmPluginName.ResourceNameType of the contained resource name.

Property Value
Type Description
WasmPluginNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

WasmPluginId

public string WasmPluginId { get; }

The WasmPlugin ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Methods

Format(string, string, string)

public static string Format(string projectId, string locationId, string wasmPluginId)

Formats the IDs into the string representation of this WasmPluginName with pattern projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

wasmPluginId string

The WasmPlugin ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this WasmPluginName with pattern projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}.

FormatProjectLocationWasmPlugin(string, string, string)

public static string FormatProjectLocationWasmPlugin(string projectId, string locationId, string wasmPluginId)

Formats the IDs into the string representation of this WasmPluginName with pattern projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

wasmPluginId string

The WasmPlugin ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this WasmPluginName with pattern projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}.

FromProjectLocationWasmPlugin(string, string, string)

public static WasmPluginName FromProjectLocationWasmPlugin(string projectId, string locationId, string wasmPluginId)

Creates a WasmPluginName with the pattern projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

wasmPluginId string

The WasmPlugin ID. Must not be null or empty.

Returns
Type Description
WasmPluginName

A new instance of WasmPluginName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static WasmPluginName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a WasmPluginName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
WasmPluginName

A new instance of WasmPluginName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static WasmPluginName Parse(string wasmPluginName)

Parses the given resource name string into a new WasmPluginName instance.

Parameter
Name Description
wasmPluginName string

The resource name in string form. Must not be null.

Returns
Type Description
WasmPluginName

The parsed WasmPluginName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}

Parse(string, bool)

public static WasmPluginName Parse(string wasmPluginName, bool allowUnparsed)

Parses the given resource name string into a new WasmPluginName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
wasmPluginName string

The resource name in string form. Must not be null.

allowUnparsed bool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

Returns
Type Description
WasmPluginName

The parsed WasmPluginName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type Description
string

The string representation of the resource name.

Overrides

TryParse(string, out WasmPluginName)

public static bool TryParse(string wasmPluginName, out WasmPluginName result)

Tries to parse the given resource name string into a new WasmPluginName instance.

Parameters
Name Description
wasmPluginName string

The resource name in string form. Must not be null.

result WasmPluginName

When this method returns, the parsed WasmPluginName, or null if parsing failed.

Returns
Type Description
bool

true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}

TryParse(string, bool, out WasmPluginName)

public static bool TryParse(string wasmPluginName, bool allowUnparsed, out WasmPluginName result)

Tries to parse the given resource name string into a new WasmPluginName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
wasmPluginName string

The resource name in string form. Must not be null.

allowUnparsed bool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

result WasmPluginName

When this method returns, the parsed WasmPluginName, or null if parsing failed.

Returns
Type Description
bool

true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/wasmPlugins/{wasm_plugin}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(WasmPluginName, WasmPluginName)

public static bool operator ==(WasmPluginName a, WasmPluginName b)

Determines whether two specified resource names have the same value.

Parameters
Name Description
a WasmPluginName

The first resource name to compare, or null.

b WasmPluginName

The second resource name to compare, or null.

Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(WasmPluginName, WasmPluginName)

public static bool operator !=(WasmPluginName a, WasmPluginName b)

Determines whether two specified resource names have different values.

Parameters
Name Description
a WasmPluginName

The first resource name to compare, or null.

b WasmPluginName

The second resource name to compare, or null.

Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.