Class VersionName (1.0.0-beta02)

public sealed class VersionName : IResourceName, IEquatable<VersionName>

Resource name for the Version resource.

Inheritance

Object > VersionName

Implements

IResourceName, IEquatable<VersionName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.PrivateCatalog.V1Beta1

Assembly

Google.Cloud.PrivateCatalog.V1Beta1.dll

Constructors

VersionName(String, String, String)

public VersionName(string catalogId, string productId, string versionId)

Constructs a new instance of a VersionName class from the component parts of pattern catalogs/{catalog}/products/{product}/versions/{version}

Parameters
Name	Description
`catalogId`	`String` The `Catalog` ID. Must not be `null` or empty.
`productId`	`String` The `Product` ID. Must not be `null` or empty.
`versionId`	`String` The `Version` ID. Must not be `null` or empty.

Properties

CatalogId

public string CatalogId { get; }

The Catalog 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
`Boolean`

ProductId

public string ProductId { get; }

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

Property Value
Type	Description
`String`

Type

public VersionName.ResourceNameType Type { get; }

The VersionName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`VersionName.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`

VersionId

public string VersionId { get; }

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

Property Value
Type	Description
`String`

Methods

Format(String, String, String)

public static string Format(string catalogId, string productId, string versionId)

Formats the IDs into the string representation of this VersionName with pattern catalogs/{catalog}/products/{product}/versions/{version}.

Parameters
Name	Description
`catalogId`	`String` The `Catalog` ID. Must not be `null` or empty.
`productId`	`String` The `Product` ID. Must not be `null` or empty.
`versionId`	`String` The `Version` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this VersionName with pattern `catalogs/{catalog}/products/{product}/versions/{version}`.

FormatCatalogProductVersion(String, String, String)

public static string FormatCatalogProductVersion(string catalogId, string productId, string versionId)

Formats the IDs into the string representation of this VersionName with pattern catalogs/{catalog}/products/{product}/versions/{version}.

Parameters
Name	Description
`catalogId`	`String` The `Catalog` ID. Must not be `null` or empty.
`productId`	`String` The `Product` ID. Must not be `null` or empty.
`versionId`	`String` The `Version` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this VersionName with pattern `catalogs/{catalog}/products/{product}/versions/{version}`.

FromCatalogProductVersion(String, String, String)

public static VersionName FromCatalogProductVersion(string catalogId, string productId, string versionId)

Creates a VersionName with the pattern catalogs/{catalog}/products/{product}/versions/{version}.

Parameters
Name	Description
`catalogId`	`String` The `Catalog` ID. Must not be `null` or empty.
`productId`	`String` The `Product` ID. Must not be `null` or empty.
`versionId`	`String` The `Version` ID. Must not be `null` or empty.

Returns
Type	Description
`VersionName`	A new instance of VersionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static VersionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a VersionName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`VersionName`	A new instance of VersionName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static VersionName Parse(string versionName)

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

Parameter
Name	Description
`versionName`	`String` The resource name in string form. Must not be `null`.

Returns
Type	Description
`VersionName`	The parsed VersionName if successful.

Remarks

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

catalogs/{catalog}/products/{product}/versions/{version}

Parse(String, Boolean)

public static VersionName Parse(string versionName, bool allowUnparsed)

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

Parameters
Name	Description
`versionName`	`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
`VersionName`	The parsed VersionName if successful.

Remarks

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

catalogs/{catalog}/products/{product}/versions/{version}

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

Object.ToString()

TryParse(String, out VersionName)

public static bool TryParse(string versionName, out VersionName result)

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

Parameters
Name	Description
`versionName`	`String` The resource name in string form. Must not be `null`.
`result`	`VersionName` When this method returns, the parsed VersionName, 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:

catalogs/{catalog}/products/{product}/versions/{version}

TryParse(String, Boolean, out VersionName)

public static bool TryParse(string versionName, bool allowUnparsed, out VersionName result)

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

Parameters
Name	Description
`versionName`	`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`	`VersionName` When this method returns, the parsed VersionName, 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:

catalogs/{catalog}/products/{product}/versions/{version}

Or may be in any format if allowUnparsed is true.

Operators

Equality(VersionName, VersionName)

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

Parameters
Name	Description
`a`	`VersionName`
`b`	`VersionName`

Returns
Type	Description
`Boolean`

Inequality(VersionName, VersionName)

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

Parameters
Name	Description
`a`	`VersionName`
`b`	`VersionName`

Returns
Type	Description
`Boolean`