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

public sealed class DataSourceReferenceName : IResourceName, IEquatable<DataSourceReferenceName>

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

Resource name for the DataSourceReference resource.

Inheritance

object > DataSourceReferenceName

Namespace

Google.Cloud.BackupDR.V1

Assembly

Google.Cloud.BackupDR.V1.dll

Constructors

DataSourceReferenceName(string, string, string)

public DataSourceReferenceName(string projectId, string locationId, string dataSourceReferenceId)

Constructs a new instance of a DataSourceReferenceName class from the component parts of pattern projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference}

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

The DataSourceReference ID. Must not be null or empty.

Properties

DataSourceReferenceId

public string DataSourceReferenceId { get; }

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

The DataSourceReferenceName.ResourceNameType of the contained resource name.

Property Value
Type Description
DataSourceReferenceNameResourceNameType

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

Formats the IDs into the string representation of this DataSourceReferenceName with pattern projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference}.

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

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

The string representation of this DataSourceReferenceName with pattern projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference}.

FormatProjectLocationDataSourceReference(string, string, string)

public static string FormatProjectLocationDataSourceReference(string projectId, string locationId, string dataSourceReferenceId)

Formats the IDs into the string representation of this DataSourceReferenceName with pattern projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference}.

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

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

The string representation of this DataSourceReferenceName with pattern projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference}.

FromProjectLocationDataSourceReference(string, string, string)

public static DataSourceReferenceName FromProjectLocationDataSourceReference(string projectId, string locationId, string dataSourceReferenceId)

Creates a DataSourceReferenceName with the pattern projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference}.

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

The DataSourceReference ID. Must not be null or empty.
Returns
Type Description
DataSourceReferenceName

A new instance of DataSourceReferenceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DataSourceReferenceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DataSourceReferenceName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
dataSourceReferenceName string

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

The parsed DataSourceReferenceName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference}

Parse(string, bool)

public static DataSourceReferenceName Parse(string dataSourceReferenceName, bool allowUnparsed)

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

Parameters
Name Description
dataSourceReferenceName 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
DataSourceReferenceName

The parsed DataSourceReferenceName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference}
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 DataSourceReferenceName)

public static bool TryParse(string dataSourceReferenceName, out DataSourceReferenceName result)

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

Parameters
Name Description
dataSourceReferenceName string

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

When this method returns, the parsed DataSourceReferenceName, 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}/dataSourceReferences/{data_source_reference}

TryParse(string, bool, out DataSourceReferenceName)

public static bool TryParse(string dataSourceReferenceName, bool allowUnparsed, out DataSourceReferenceName result)

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

Parameters
Name Description
dataSourceReferenceName 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 DataSourceReferenceName

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

Operators

operator ==(DataSourceReferenceName, DataSourceReferenceName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DataSourceReferenceName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DataSourceReferenceName

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

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.