Design Center v1 API - Class ShareName (1.0.0-beta01) 

public sealed class ShareName : IResourceName, IEquatable<ShareName>

Reference documentation and code samples for the Design Center v1 API class ShareName.

Resource name for the Share resource.

Inheritance

object > ShareName

Namespace

Google.Cloud.DesignCenter.V1

Assembly

Google.Cloud.DesignCenter.V1.dll

Constructors

ShareName(string, string, string, string, string)

public ShareName(string projectId, string locationId, string spaceId, string catalogId, string shareId)

Constructs a new instance of a ShareName class from the component parts of pattern projects/{project}/locations/{location}/spaces/{space}/catalogs/{catalog}/shares/{share}

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

The Space ID. Must not be null or empty.
catalogId string

The Catalog ID. Must not be null or empty.
shareId string

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

ShareId

public string ShareId { get; }

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

Property Value
Type Description
string

SpaceId

public string SpaceId { get; }

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

Property Value
Type Description
string

Type

public ShareName.ResourceNameType Type { get; }

The ShareName.ResourceNameType of the contained resource name.

Property Value
Type Description
ShareNameResourceNameType

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, string, string)

public static string Format(string projectId, string locationId, string spaceId, string catalogId, string shareId)

Formats the IDs into the string representation of this ShareName with pattern projects/{project}/locations/{location}/spaces/{space}/catalogs/{catalog}/shares/{share}.

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

The Space ID. Must not be null or empty.
catalogId string

The Catalog ID. Must not be null or empty.
shareId string

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

The string representation of this ShareName with pattern projects/{project}/locations/{location}/spaces/{space}/catalogs/{catalog}/shares/{share}.

FormatProjectLocationSpaceCatalogShare(string, string, string, string, string)

public static string FormatProjectLocationSpaceCatalogShare(string projectId, string locationId, string spaceId, string catalogId, string shareId)

Formats the IDs into the string representation of this ShareName with pattern projects/{project}/locations/{location}/spaces/{space}/catalogs/{catalog}/shares/{share}.

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

The Space ID. Must not be null or empty.
catalogId string

The Catalog ID. Must not be null or empty.
shareId string

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

The string representation of this ShareName with pattern projects/{project}/locations/{location}/spaces/{space}/catalogs/{catalog}/shares/{share}.

FromProjectLocationSpaceCatalogShare(string, string, string, string, string)

public static ShareName FromProjectLocationSpaceCatalogShare(string projectId, string locationId, string spaceId, string catalogId, string shareId)

Creates a ShareName with the pattern projects/{project}/locations/{location}/spaces/{space}/catalogs/{catalog}/shares/{share}.

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

The Space ID. Must not be null or empty.
catalogId string

The Catalog ID. Must not be null or empty.
shareId string

The Share ID. Must not be null or empty.
Returns
Type Description
ShareName

A new instance of ShareName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ShareName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ShareName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
shareName string

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

The parsed ShareName if successful.
Remarks

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

  • projects/{project}/locations/{location}/spaces/{space}/catalogs/{catalog}/shares/{share}

Parse(string, bool)

public static ShareName Parse(string shareName, bool allowUnparsed)

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

Parameters
Name Description
shareName 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
ShareName

The parsed ShareName if successful.
Remarks

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

  • projects/{project}/locations/{location}/spaces/{space}/catalogs/{catalog}/shares/{share}

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

public static bool TryParse(string shareName, out ShareName result)

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

Parameters
Name Description
shareName string

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

When this method returns, the parsed ShareName, 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}/spaces/{space}/catalogs/{catalog}/shares/{share}

TryParse(string, bool, out ShareName)

public static bool TryParse(string shareName, bool allowUnparsed, out ShareName result)

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

Parameters
Name Description
shareName 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 ShareName

When this method returns, the parsed ShareName, 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}/spaces/{space}/catalogs/{catalog}/shares/{share}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ShareName, ShareName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ShareName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ShareName

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

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.