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

public sealed class SharedTemplateName : IResourceName, IEquatable<SharedTemplateName>

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

Resource name for the SharedTemplate resource.

Inheritance

object > SharedTemplateName

Namespace

Google.Cloud.DesignCenter.V1

Assembly

Google.Cloud.DesignCenter.V1.dll

Constructors

SharedTemplateName(string, string, string, string)

public SharedTemplateName(string projectId, string locationId, string spaceId, string sharedTemplateId)

Constructs a new instance of a SharedTemplateName class from the component parts of pattern projects/{project}/locations/{location}/spaces/{space}/sharedTemplates/{shared_template}

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

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

SharedTemplateId

public string SharedTemplateId { get; }

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

The SharedTemplateName.ResourceNameType of the contained resource name.

Property Value
Type Description
SharedTemplateNameResourceNameType

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)

public static string Format(string projectId, string locationId, string spaceId, string sharedTemplateId)

Formats the IDs into the string representation of this SharedTemplateName with pattern projects/{project}/locations/{location}/spaces/{space}/sharedTemplates/{shared_template}.

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

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

The string representation of this SharedTemplateName with pattern projects/{project}/locations/{location}/spaces/{space}/sharedTemplates/{shared_template}.

FormatProjectLocationSpaceSharedTemplate(string, string, string, string)

public static string FormatProjectLocationSpaceSharedTemplate(string projectId, string locationId, string spaceId, string sharedTemplateId)

Formats the IDs into the string representation of this SharedTemplateName with pattern projects/{project}/locations/{location}/spaces/{space}/sharedTemplates/{shared_template}.

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

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

The string representation of this SharedTemplateName with pattern projects/{project}/locations/{location}/spaces/{space}/sharedTemplates/{shared_template}.

FromProjectLocationSpaceSharedTemplate(string, string, string, string)

public static SharedTemplateName FromProjectLocationSpaceSharedTemplate(string projectId, string locationId, string spaceId, string sharedTemplateId)

Creates a SharedTemplateName with the pattern projects/{project}/locations/{location}/spaces/{space}/sharedTemplates/{shared_template}.

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

The SharedTemplate ID. Must not be null or empty.
Returns
Type Description
SharedTemplateName

A new instance of SharedTemplateName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SharedTemplateName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SharedTemplateName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
sharedTemplateName string

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

The parsed SharedTemplateName if successful.
Remarks

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

  • projects/{project}/locations/{location}/spaces/{space}/sharedTemplates/{shared_template}

Parse(string, bool)

public static SharedTemplateName Parse(string sharedTemplateName, bool allowUnparsed)

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

Parameters
Name Description
sharedTemplateName 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
SharedTemplateName

The parsed SharedTemplateName if successful.
Remarks

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

  • projects/{project}/locations/{location}/spaces/{space}/sharedTemplates/{shared_template}

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

public static bool TryParse(string sharedTemplateName, out SharedTemplateName result)

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

Parameters
Name Description
sharedTemplateName string

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

When this method returns, the parsed SharedTemplateName, 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}/sharedTemplates/{shared_template}

TryParse(string, bool, out SharedTemplateName)

public static bool TryParse(string sharedTemplateName, bool allowUnparsed, out SharedTemplateName result)

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

Parameters
Name Description
sharedTemplateName 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 SharedTemplateName

When this method returns, the parsed SharedTemplateName, 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}/sharedTemplates/{shared_template}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SharedTemplateName, SharedTemplateName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SharedTemplateName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SharedTemplateName

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

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.