API hub v1 API - Class HostProjectRegistrationName (1.0.0) 

public sealed class HostProjectRegistrationName : IResourceName, IEquatable<HostProjectRegistrationName>

Reference documentation and code samples for the API hub v1 API class HostProjectRegistrationName.

Resource name for the HostProjectRegistration resource.

Inheritance

object > HostProjectRegistrationName

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

HostProjectRegistrationName(string, string, string)

public HostProjectRegistrationName(string projectId, string locationId, string hostProjectRegistrationId)

Constructs a new instance of a HostProjectRegistrationName class from the component parts of pattern projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration}

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

The HostProjectRegistration ID. Must not be null or empty.

Properties

HostProjectRegistrationId

public string HostProjectRegistrationId { get; }

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

The HostProjectRegistrationName.ResourceNameType of the contained resource name.

Property Value
Type Description
HostProjectRegistrationNameResourceNameType

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

Formats the IDs into the string representation of this HostProjectRegistrationName with pattern projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration}.

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

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

The string representation of this HostProjectRegistrationName with pattern projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration}.

FormatProjectLocationHostProjectRegistration(string, string, string)

public static string FormatProjectLocationHostProjectRegistration(string projectId, string locationId, string hostProjectRegistrationId)

Formats the IDs into the string representation of this HostProjectRegistrationName with pattern projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration}.

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

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

The string representation of this HostProjectRegistrationName with pattern projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration}.

FromProjectLocationHostProjectRegistration(string, string, string)

public static HostProjectRegistrationName FromProjectLocationHostProjectRegistration(string projectId, string locationId, string hostProjectRegistrationId)

Creates a HostProjectRegistrationName with the pattern projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration}.

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

The HostProjectRegistration ID. Must not be null or empty.
Returns
Type Description
HostProjectRegistrationName

A new instance of HostProjectRegistrationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static HostProjectRegistrationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a HostProjectRegistrationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
hostProjectRegistrationName string

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

The parsed HostProjectRegistrationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration}

Parse(string, bool)

public static HostProjectRegistrationName Parse(string hostProjectRegistrationName, bool allowUnparsed)

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

Parameters
Name Description
hostProjectRegistrationName 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
HostProjectRegistrationName

The parsed HostProjectRegistrationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration}
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 HostProjectRegistrationName)

public static bool TryParse(string hostProjectRegistrationName, out HostProjectRegistrationName result)

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

Parameters
Name Description
hostProjectRegistrationName string

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

When this method returns, the parsed HostProjectRegistrationName, 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}/hostProjectRegistrations/{host_project_registration}

TryParse(string, bool, out HostProjectRegistrationName)

public static bool TryParse(string hostProjectRegistrationName, bool allowUnparsed, out HostProjectRegistrationName result)

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

Parameters
Name Description
hostProjectRegistrationName 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 HostProjectRegistrationName

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

Operators

operator ==(HostProjectRegistrationName, HostProjectRegistrationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a HostProjectRegistrationName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a HostProjectRegistrationName

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

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.