Backup and DR Service v1 API - Class BackupPlanName (2.0.0) 

public sealed class BackupPlanName : IResourceName, IEquatable<BackupPlanName>

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

Resource name for the BackupPlan resource.

Inheritance

object > BackupPlanName

Namespace

Google.Cloud.BackupDR.V1

Assembly

Google.Cloud.BackupDR.V1.dll

Constructors

BackupPlanName(string, string, string)

public BackupPlanName(string projectId, string locationId, string backupPlanId)

Constructs a new instance of a BackupPlanName class from the component parts of pattern projects/{project}/locations/{location}/backupPlans/{backup_plan}

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

The BackupPlan ID. Must not be null or empty.

Properties

BackupPlanId

public string BackupPlanId { get; }

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

Property Value
Type Description
string

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 BackupPlanName.ResourceNameType Type { get; }

The BackupPlanName.ResourceNameType of the contained resource name.

Property Value
Type Description
BackupPlanNameResourceNameType

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

Formats the IDs into the string representation of this BackupPlanName with pattern projects/{project}/locations/{location}/backupPlans/{backup_plan}.

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

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

The string representation of this BackupPlanName with pattern projects/{project}/locations/{location}/backupPlans/{backup_plan}.

FormatProjectLocationBackupPlan(string, string, string)

public static string FormatProjectLocationBackupPlan(string projectId, string locationId, string backupPlanId)

Formats the IDs into the string representation of this BackupPlanName with pattern projects/{project}/locations/{location}/backupPlans/{backup_plan}.

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

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

The string representation of this BackupPlanName with pattern projects/{project}/locations/{location}/backupPlans/{backup_plan}.

FromProjectLocationBackupPlan(string, string, string)

public static BackupPlanName FromProjectLocationBackupPlan(string projectId, string locationId, string backupPlanId)

Creates a BackupPlanName with the pattern projects/{project}/locations/{location}/backupPlans/{backup_plan}.

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

The BackupPlan ID. Must not be null or empty.
Returns
Type Description
BackupPlanName

A new instance of BackupPlanName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static BackupPlanName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BackupPlanName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
backupPlanName string

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

The parsed BackupPlanName if successful.
Remarks

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

  • projects/{project}/locations/{location}/backupPlans/{backup_plan}

Parse(string, bool)

public static BackupPlanName Parse(string backupPlanName, bool allowUnparsed)

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

Parameters
Name Description
backupPlanName 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
BackupPlanName

The parsed BackupPlanName if successful.
Remarks

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

  • projects/{project}/locations/{location}/backupPlans/{backup_plan}
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 BackupPlanName)

public static bool TryParse(string backupPlanName, out BackupPlanName result)

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

Parameters
Name Description
backupPlanName string

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

When this method returns, the parsed BackupPlanName, 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}/backupPlans/{backup_plan}

TryParse(string, bool, out BackupPlanName)

public static bool TryParse(string backupPlanName, bool allowUnparsed, out BackupPlanName result)

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

Parameters
Name Description
backupPlanName 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 BackupPlanName

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

Operators

operator ==(BackupPlanName, BackupPlanName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a BackupPlanName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a BackupPlanName

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

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.