Backup and DR Service v1 API - Class BackupPlanRevisionName (2.2.0) 

public sealed class BackupPlanRevisionName : IResourceName, IEquatable<BackupPlanRevisionName>

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

Resource name for the BackupPlanRevision resource.

Inheritance

object > BackupPlanRevisionName

Namespace

Google.Cloud.BackupDR.V1

Assembly

Google.Cloud.BackupDR.V1.dll

Constructors

BackupPlanRevisionName(string, string, string, string)

public BackupPlanRevisionName(string projectId, string locationId, string backupPlanId, string revisionId)

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

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

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

RevisionId

public string RevisionId { get; }

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

Property Value
Type Description
string

Type

public BackupPlanRevisionName.ResourceNameType Type { get; }

The BackupPlanRevisionName.ResourceNameType of the contained resource name.

Property Value
Type Description
BackupPlanRevisionNameResourceNameType

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, string)

public static string Format(string projectId, string locationId, string backupPlanId, string revisionId)

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

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

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

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

FormatProjectLocationBackupPlanRevision(string, string, string, string)

public static string FormatProjectLocationBackupPlanRevision(string projectId, string locationId, string backupPlanId, string revisionId)

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

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

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

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

FromProjectLocationBackupPlanRevision(string, string, string, string)

public static BackupPlanRevisionName FromProjectLocationBackupPlanRevision(string projectId, string locationId, string backupPlanId, string revisionId)

Creates a BackupPlanRevisionName with the pattern projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision}.

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

The Revision ID. Must not be null or empty.
Returns
Type Description
BackupPlanRevisionName

A new instance of BackupPlanRevisionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static BackupPlanRevisionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BackupPlanRevisionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
backupPlanRevisionName string

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

The parsed BackupPlanRevisionName if successful.
Remarks

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

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

Parse(string, bool)

public static BackupPlanRevisionName Parse(string backupPlanRevisionName, bool allowUnparsed)

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

Parameters
Name Description
backupPlanRevisionName 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
BackupPlanRevisionName

The parsed BackupPlanRevisionName if successful.
Remarks

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

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

public static bool TryParse(string backupPlanRevisionName, out BackupPlanRevisionName result)

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

Parameters
Name Description
backupPlanRevisionName string

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

When this method returns, the parsed BackupPlanRevisionName, 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}/revisions/{revision}

TryParse(string, bool, out BackupPlanRevisionName)

public static bool TryParse(string backupPlanRevisionName, bool allowUnparsed, out BackupPlanRevisionName result)

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

Parameters
Name Description
backupPlanRevisionName 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 BackupPlanRevisionName

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

Operators

operator ==(BackupPlanRevisionName, BackupPlanRevisionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a BackupPlanRevisionName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a BackupPlanRevisionName

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

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.