Class SourceName (2.0.0) 

public sealed class SourceName : IResourceName, IEquatable<SourceName>

Resource name for the Source resource.

Inheritance

Object > SourceName

Namespace

Google.Cloud.VMMigration.V1

Assembly

Google.Cloud.VMMigration.V1.dll

Constructors

SourceName(String, String, String)

public SourceName(string projectId, string locationId, string sourceId)

Constructs a new instance of a SourceName class from the component parts of pattern projects/{project}/locations/{location}/sources/{source}

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.
sourceId String

The Source ID. Must not be null or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type Description
Boolean

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

SourceId

public string SourceId { get; }

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

Property Value
Type Description
String

Type

public SourceName.ResourceNameType Type { get; }

The SourceName.ResourceNameType of the contained resource name.

Property Value
Type Description
SourceName.ResourceNameType

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

Formats the IDs into the string representation of this SourceName with pattern projects/{project}/locations/{location}/sources/{source}.

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.
sourceId String

The Source ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this SourceName with pattern projects/{project}/locations/{location}/sources/{source}.

FormatProjectLocationSource(String, String, String)

public static string FormatProjectLocationSource(string projectId, string locationId, string sourceId)

Formats the IDs into the string representation of this SourceName with pattern projects/{project}/locations/{location}/sources/{source}.

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.
sourceId String

The Source ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this SourceName with pattern projects/{project}/locations/{location}/sources/{source}.

FromProjectLocationSource(String, String, String)

public static SourceName FromProjectLocationSource(string projectId, string locationId, string sourceId)

Creates a SourceName with the pattern projects/{project}/locations/{location}/sources/{source}.

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.
sourceId String

The Source ID. Must not be null or empty.
Returns
Type Description
SourceName

A new instance of SourceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SourceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SourceName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of SourceName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
Int32
Overrides

Parse(String)

public static SourceName Parse(string sourceName)

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

Parameter
Name Description
sourceName String

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

The parsed SourceName if successful.
Remarks

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

  • projects/{project}/locations/{location}/sources/{source}

Parse(String, Boolean)

public static SourceName Parse(string sourceName, bool allowUnparsed)

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

Parameters
Name Description
sourceName String

The resource name in string form. Must not be null.
allowUnparsed Boolean

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
SourceName

The parsed SourceName if successful.
Remarks

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

  • projects/{project}/locations/{location}/sources/{source}
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 SourceName)

public static bool TryParse(string sourceName, out SourceName result)

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

Parameters
Name Description
sourceName String

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

When this method returns, the parsed SourceName, or null if parsing failed.
Returns
Type Description
Boolean

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}/sources/{source}

TryParse(String, Boolean, out SourceName)

public static bool TryParse(string sourceName, bool allowUnparsed, out SourceName result)

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

Parameters
Name Description
sourceName String

The resource name in string form. Must not be null.
allowUnparsed Boolean

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 SourceName

When this method returns, the parsed SourceName, or null if parsing failed.
Returns
Type Description
Boolean

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}/sources/{source}
Or may be in any format if allowUnparsed is true.

Operators

Equality(SourceName, SourceName)

public static bool operator ==(SourceName a, SourceName b)
Parameters
Name Description
a SourceName
b SourceName
Returns
Type Description
Boolean

Inequality(SourceName, SourceName)

public static bool operator !=(SourceName a, SourceName b)
Parameters
Name Description
a SourceName
b SourceName
Returns
Type Description
Boolean