Backup and DR Service v1 API - Class ManagementServerName (1.1.0) 

public sealed class ManagementServerName : IResourceName, IEquatable<ManagementServerName>

Reference documentation and code samples for the Backup and DR Service v1 API class ManagementServerName.

Resource name for the ManagementServer resource.

Inheritance

object > ManagementServerName

Namespace

Google.Cloud.BackupDR.V1

Assembly

Google.Cloud.BackupDR.V1.dll

Constructors

ManagementServerName(string, string, string)

public ManagementServerName(string projectId, string locationId, string managementserverId)

Constructs a new instance of a ManagementServerName class from the component parts of pattern projects/{project}/locations/{location}/managementServers/{managementserver}

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

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

ManagementserverId

public string ManagementserverId { get; }

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

The ManagementServerName.ResourceNameType of the contained resource name.

Property Value
Type Description
ManagementServerNameResourceNameType

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

Formats the IDs into the string representation of this ManagementServerName with pattern projects/{project}/locations/{location}/managementServers/{managementserver}.

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

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

The string representation of this ManagementServerName with pattern projects/{project}/locations/{location}/managementServers/{managementserver}.

FormatProjectLocationManagementserver(string, string, string)

public static string FormatProjectLocationManagementserver(string projectId, string locationId, string managementserverId)

Formats the IDs into the string representation of this ManagementServerName with pattern projects/{project}/locations/{location}/managementServers/{managementserver}.

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

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

The string representation of this ManagementServerName with pattern projects/{project}/locations/{location}/managementServers/{managementserver}.

FromProjectLocationManagementserver(string, string, string)

public static ManagementServerName FromProjectLocationManagementserver(string projectId, string locationId, string managementserverId)

Creates a ManagementServerName with the pattern projects/{project}/locations/{location}/managementServers/{managementserver}.

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

The Managementserver ID. Must not be null or empty.
Returns
Type Description
ManagementServerName

A new instance of ManagementServerName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ManagementServerName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ManagementServerName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
managementServerName string

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

The parsed ManagementServerName if successful.
Remarks

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

  • projects/{project}/locations/{location}/managementServers/{managementserver}

Parse(string, bool)

public static ManagementServerName Parse(string managementServerName, bool allowUnparsed)

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

Parameters
Name Description
managementServerName 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
ManagementServerName

The parsed ManagementServerName if successful.
Remarks

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

  • projects/{project}/locations/{location}/managementServers/{managementserver}
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 ManagementServerName)

public static bool TryParse(string managementServerName, out ManagementServerName result)

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

Parameters
Name Description
managementServerName string

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

When this method returns, the parsed ManagementServerName, 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}/managementServers/{managementserver}

TryParse(string, bool, out ManagementServerName)

public static bool TryParse(string managementServerName, bool allowUnparsed, out ManagementServerName result)

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

Parameters
Name Description
managementServerName 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 ManagementServerName

When this method returns, the parsed ManagementServerName, 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}/managementServers/{managementserver}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ManagementServerName, ManagementServerName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ManagementServerName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ManagementServerName

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

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.