GDC Hardware Management v1alpha API - Class SiteName (1.0.0-alpha02) 

public sealed class SiteName : IResourceName, IEquatable<SiteName>

Reference documentation and code samples for the GDC Hardware Management v1alpha API class SiteName.

Resource name for the Site resource.

Inheritance

object > SiteName

Namespace

Google.Cloud.GdcHardwareManagement.V1Alpha

Assembly

Google.Cloud.GdcHardwareManagement.V1Alpha.dll

Constructors

SiteName(string, string, string)

public SiteName(string projectId, string locationId, string siteId)

Constructs a new instance of a SiteName class from the component parts of pattern projects/{project}/locations/{location}/sites/{site}

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

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

SiteId

public string SiteId { get; }

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

Property Value
Type Description
string

Type

public SiteName.ResourceNameType Type { get; }

The SiteName.ResourceNameType of the contained resource name.

Property Value
Type Description
SiteNameResourceNameType

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

Formats the IDs into the string representation of this SiteName with pattern projects/{project}/locations/{location}/sites/{site}.

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

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

The string representation of this SiteName with pattern projects/{project}/locations/{location}/sites/{site}.

FormatProjectLocationSite(string, string, string)

public static string FormatProjectLocationSite(string projectId, string locationId, string siteId)

Formats the IDs into the string representation of this SiteName with pattern projects/{project}/locations/{location}/sites/{site}.

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

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

The string representation of this SiteName with pattern projects/{project}/locations/{location}/sites/{site}.

FromProjectLocationSite(string, string, string)

public static SiteName FromProjectLocationSite(string projectId, string locationId, string siteId)

Creates a SiteName with the pattern projects/{project}/locations/{location}/sites/{site} .

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

The Site ID. Must not be null or empty.
Returns
Type Description
SiteName

A new instance of SiteName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SiteName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SiteName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
siteName string

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

The parsed SiteName if successful.
Remarks

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

  • projects/{project}/locations/{location}/sites/{site}

Parse(string, bool)

public static SiteName Parse(string siteName, bool allowUnparsed)

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

Parameters
Name Description
siteName 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
SiteName

The parsed SiteName if successful.
Remarks

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

  • projects/{project}/locations/{location}/sites/{site}
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 SiteName)

public static bool TryParse(string siteName, out SiteName result)

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

Parameters
Name Description
siteName string

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

When this method returns, the parsed SiteName, 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}/sites/{site}

TryParse(string, bool, out SiteName)

public static bool TryParse(string siteName, bool allowUnparsed, out SiteName result)

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

Parameters
Name Description
siteName 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 SiteName

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

Operators

operator ==(SiteName, SiteName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SiteName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SiteName

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

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.