Firestore Admin v1 API - Class BackupName (3.8.0) 

public sealed class BackupName : IResourceName, IEquatable<BackupName>

Reference documentation and code samples for the Firestore Admin v1 API class BackupName.

Resource name for the Backup resource.

Inheritance

object > BackupName

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

BackupName(string, string, string)

public BackupName(string projectId, string locationId, string backupId)

Constructs a new instance of a BackupName class from the component parts of pattern projects/{project}/locations/{location}/backups/{backup}

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

The Backup ID. Must not be null or empty.

Properties

BackupId

public string BackupId { get; }

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

The BackupName.ResourceNameType of the contained resource name.

Property Value
Type Description
BackupNameResourceNameType

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

Formats the IDs into the string representation of this BackupName with pattern projects/{project}/locations/{location}/backups/{backup}.

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

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

The string representation of this BackupName with pattern projects/{project}/locations/{location}/backups/{backup}.

FormatProjectLocationBackup(string, string, string)

public static string FormatProjectLocationBackup(string projectId, string locationId, string backupId)

Formats the IDs into the string representation of this BackupName with pattern projects/{project}/locations/{location}/backups/{backup}.

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

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

The string representation of this BackupName with pattern projects/{project}/locations/{location}/backups/{backup}.

FromProjectLocationBackup(string, string, string)

public static BackupName FromProjectLocationBackup(string projectId, string locationId, string backupId)

Creates a BackupName with the pattern projects/{project}/locations/{location}/backups/{backup}.

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

The Backup ID. Must not be null or empty.
Returns
Type Description
BackupName

A new instance of BackupName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static BackupName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BackupName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
backupName string

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

The parsed BackupName if successful.
Remarks

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

  • projects/{project}/locations/{location}/backups/{backup}

Parse(string, bool)

public static BackupName Parse(string backupName, bool allowUnparsed)

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

Parameters
Name Description
backupName 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
BackupName

The parsed BackupName if successful.
Remarks

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

  • projects/{project}/locations/{location}/backups/{backup}
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 BackupName)

public static bool TryParse(string backupName, out BackupName result)

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

Parameters
Name Description
backupName string

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

When this method returns, the parsed BackupName, 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}/backups/{backup}

TryParse(string, bool, out BackupName)

public static bool TryParse(string backupName, bool allowUnparsed, out BackupName result)

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

Parameters
Name Description
backupName 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 BackupName

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

Operators

operator ==(BackupName, BackupName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a BackupName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a BackupName

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

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.