Network Security v1 API - Class MirroringDeploymentName (1.0.0-beta01) 

public sealed class MirroringDeploymentName : IResourceName, IEquatable<MirroringDeploymentName>

Reference documentation and code samples for the Network Security v1 API class MirroringDeploymentName.

Resource name for the MirroringDeployment resource.

Inheritance

object > MirroringDeploymentName

Namespace

Google.Cloud.NetworkSecurity.V1

Assembly

Google.Cloud.NetworkSecurity.V1.dll

Constructors

MirroringDeploymentName(string, string, string)

public MirroringDeploymentName(string projectId, string locationId, string mirroringDeploymentId)

Constructs a new instance of a MirroringDeploymentName class from the component parts of pattern projects/{project}/locations/{location}/mirroringDeployments/{mirroring_deployment}

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.
mirroringDeploymentId string

The MirroringDeployment 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

MirroringDeploymentId

public string MirroringDeploymentId { get; }

The MirroringDeployment 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 MirroringDeploymentName.ResourceNameType Type { get; }

The MirroringDeploymentName.ResourceNameType of the contained resource name.

Property Value
Type Description
MirroringDeploymentNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

Methods

Format(string, string, string)

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

Formats the IDs into the string representation of this MirroringDeploymentName with pattern projects/{project}/locations/{location}/mirroringDeployments/{mirroring_deployment}.

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.
mirroringDeploymentId string

The MirroringDeployment ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this MirroringDeploymentName with pattern projects/{project}/locations/{location}/mirroringDeployments/{mirroring_deployment}.

FormatProjectLocationMirroringDeployment(string, string, string)

public static string FormatProjectLocationMirroringDeployment(string projectId, string locationId, string mirroringDeploymentId)

Formats the IDs into the string representation of this MirroringDeploymentName with pattern projects/{project}/locations/{location}/mirroringDeployments/{mirroring_deployment}.

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.
mirroringDeploymentId string

The MirroringDeployment ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this MirroringDeploymentName with pattern projects/{project}/locations/{location}/mirroringDeployments/{mirroring_deployment}.

FromProjectLocationMirroringDeployment(string, string, string)

public static MirroringDeploymentName FromProjectLocationMirroringDeployment(string projectId, string locationId, string mirroringDeploymentId)

Creates a MirroringDeploymentName with the pattern projects/{project}/locations/{location}/mirroringDeployments/{mirroring_deployment}.

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.
mirroringDeploymentId string

The MirroringDeployment ID. Must not be null or empty.
Returns
Type Description
MirroringDeploymentName

A new instance of MirroringDeploymentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static MirroringDeploymentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MirroringDeploymentName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
MirroringDeploymentName

A new instance of MirroringDeploymentName 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 MirroringDeploymentName Parse(string mirroringDeploymentName)

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

Parameter
Name Description
mirroringDeploymentName string

The resource name in string form. Must not be null.
Returns
Type Description
MirroringDeploymentName

The parsed MirroringDeploymentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/mirroringDeployments/{mirroring_deployment}

Parse(string, bool)

public static MirroringDeploymentName Parse(string mirroringDeploymentName, bool allowUnparsed)

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

Parameters
Name Description
mirroringDeploymentName 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
MirroringDeploymentName

The parsed MirroringDeploymentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/mirroringDeployments/{mirroring_deployment}

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 MirroringDeploymentName)

public static bool TryParse(string mirroringDeploymentName, out MirroringDeploymentName result)

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

Parameters
Name Description
mirroringDeploymentName string

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

When this method returns, the parsed MirroringDeploymentName, 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}/mirroringDeployments/{mirroring_deployment}

TryParse(string, bool, out MirroringDeploymentName)

public static bool TryParse(string mirroringDeploymentName, bool allowUnparsed, out MirroringDeploymentName result)

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

Parameters
Name Description
mirroringDeploymentName 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 MirroringDeploymentName

When this method returns, the parsed MirroringDeploymentName, 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}/mirroringDeployments/{mirroring_deployment}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(MirroringDeploymentName, MirroringDeploymentName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a MirroringDeploymentName

The first resource name to compare, or null.
b MirroringDeploymentName

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 !=(MirroringDeploymentName, MirroringDeploymentName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a MirroringDeploymentName

The first resource name to compare, or null.
b MirroringDeploymentName

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.