Firestore Admin v1 API - Class BackupScheduleName (3.15.0) 

public sealed class BackupScheduleName : IResourceName, IEquatable<BackupScheduleName>

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

Resource name for the BackupSchedule resource.

Inheritance

object > BackupScheduleName

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

BackupScheduleName(string, string, string)

public BackupScheduleName(string projectId, string databaseId, string backupScheduleId)

Constructs a new instance of a BackupScheduleName class from the component parts of pattern projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
databaseId string

The Database ID. Must not be null or empty.
backupScheduleId string

The BackupSchedule ID. Must not be null or empty.

Properties

BackupScheduleId

public string BackupScheduleId { get; }

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

Property Value
Type Description
string

DatabaseId

public string DatabaseId { get; }

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

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

The BackupScheduleName.ResourceNameType of the contained resource name.

Property Value
Type Description
BackupScheduleNameResourceNameType

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

Formats the IDs into the string representation of this BackupScheduleName with pattern projects/{project}/databases/{database}/backupSchedules/{backup_schedule}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
databaseId string

The Database ID. Must not be null or empty.
backupScheduleId string

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

The string representation of this BackupScheduleName with pattern projects/{project}/databases/{database}/backupSchedules/{backup_schedule}.

FormatProjectDatabaseBackupSchedule(string, string, string)

public static string FormatProjectDatabaseBackupSchedule(string projectId, string databaseId, string backupScheduleId)

Formats the IDs into the string representation of this BackupScheduleName with pattern projects/{project}/databases/{database}/backupSchedules/{backup_schedule}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
databaseId string

The Database ID. Must not be null or empty.
backupScheduleId string

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

The string representation of this BackupScheduleName with pattern projects/{project}/databases/{database}/backupSchedules/{backup_schedule}.

FromProjectDatabaseBackupSchedule(string, string, string)

public static BackupScheduleName FromProjectDatabaseBackupSchedule(string projectId, string databaseId, string backupScheduleId)

Creates a BackupScheduleName with the pattern projects/{project}/databases/{database}/backupSchedules/{backup_schedule}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
databaseId string

The Database ID. Must not be null or empty.
backupScheduleId string

The BackupSchedule ID. Must not be null or empty.
Returns
Type Description
BackupScheduleName

A new instance of BackupScheduleName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static BackupScheduleName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BackupScheduleName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
backupScheduleName string

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

The parsed BackupScheduleName if successful.
Remarks

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

  • projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

Parse(string, bool)

public static BackupScheduleName Parse(string backupScheduleName, bool allowUnparsed)

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

Parameters
Name Description
backupScheduleName 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
BackupScheduleName

The parsed BackupScheduleName if successful.
Remarks

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

  • projects/{project}/databases/{database}/backupSchedules/{backup_schedule}
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 BackupScheduleName)

public static bool TryParse(string backupScheduleName, out BackupScheduleName result)

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

Parameters
Name Description
backupScheduleName string

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

When this method returns, the parsed BackupScheduleName, 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}/databases/{database}/backupSchedules/{backup_schedule}

TryParse(string, bool, out BackupScheduleName)

public static bool TryParse(string backupScheduleName, bool allowUnparsed, out BackupScheduleName result)

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

Parameters
Name Description
backupScheduleName 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 BackupScheduleName

When this method returns, the parsed BackupScheduleName, 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}/databases/{database}/backupSchedules/{backup_schedule}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(BackupScheduleName, BackupScheduleName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a BackupScheduleName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a BackupScheduleName

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

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.