API hub v1 API - Class CurationName (1.1.0) 

public sealed class CurationName : IResourceName, IEquatable<CurationName>

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

Resource name for the Curation resource.

Inheritance

object > CurationName

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

CurationName(string, string, string)

public CurationName(string projectId, string locationId, string curationId)

Constructs a new instance of a CurationName class from the component parts of pattern projects/{project}/locations/{location}/curations/{curation}

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

The Curation ID. Must not be null or empty.

Properties

CurationId

public string CurationId { get; }

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

The CurationName.ResourceNameType of the contained resource name.

Property Value
Type Description
CurationNameResourceNameType

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

Formats the IDs into the string representation of this CurationName with pattern projects/{project}/locations/{location}/curations/{curation}.

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

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

The string representation of this CurationName with pattern projects/{project}/locations/{location}/curations/{curation}.

FormatProjectLocationCuration(string, string, string)

public static string FormatProjectLocationCuration(string projectId, string locationId, string curationId)

Formats the IDs into the string representation of this CurationName with pattern projects/{project}/locations/{location}/curations/{curation}.

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

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

The string representation of this CurationName with pattern projects/{project}/locations/{location}/curations/{curation}.

FromProjectLocationCuration(string, string, string)

public static CurationName FromProjectLocationCuration(string projectId, string locationId, string curationId)

Creates a CurationName with the pattern projects/{project}/locations/{location}/curations/{curation}.

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

The Curation ID. Must not be null or empty.
Returns
Type Description
CurationName

A new instance of CurationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CurationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CurationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
curationName string

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

The parsed CurationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/curations/{curation}

Parse(string, bool)

public static CurationName Parse(string curationName, bool allowUnparsed)

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

Parameters
Name Description
curationName 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
CurationName

The parsed CurationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/curations/{curation}
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 CurationName)

public static bool TryParse(string curationName, out CurationName result)

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

Parameters
Name Description
curationName string

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

When this method returns, the parsed CurationName, 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}/curations/{curation}

TryParse(string, bool, out CurationName)

public static bool TryParse(string curationName, bool allowUnparsed, out CurationName result)

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

Parameters
Name Description
curationName 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 CurationName

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

Operators

operator ==(CurationName, CurationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a CurationName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a CurationName

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

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.