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

public sealed class SharedTemplateRevisionName : IResourceName, IEquatable<SharedTemplateRevisionName>

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

Resource name for the SharedTemplateRevision resource.

Inheritance

object > SharedTemplateRevisionName

Namespace

Google.Cloud.DesignCenter.V1

Assembly

Google.Cloud.DesignCenter.V1.dll

Constructors

SharedTemplateRevisionName(string, string, string, string, string)

public SharedTemplateRevisionName(string projectId, string locationId, string spaceId, string sharedTemplateId, string revisionId)

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

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.

revisionId string

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

RevisionId

public string RevisionId { get; }

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

The SharedTemplateRevisionName.ResourceNameType of the contained resource name.

Property Value
Type Description
SharedTemplateRevisionNameResourceNameType

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

Formats the IDs into the string representation of this SharedTemplateRevisionName with pattern

projects/{project}/locations/{location}/spaces/{space}/sharedTemplates/{shared_template}/revisions/{revision} .

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.

revisionId string

The Revision ID. Must not be null or empty.

Returns
Type Description
string

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

FormatProjectLocationSpaceSharedTemplateRevision(string, string, string, string, string)

public static string FormatProjectLocationSpaceSharedTemplateRevision(string projectId, string locationId, string spaceId, string sharedTemplateId, string revisionId)

Formats the IDs into the string representation of this SharedTemplateRevisionName with pattern

projects/{project}/locations/{location}/spaces/{space}/sharedTemplates/{shared_template}/revisions/{revision} .

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.

revisionId string

The Revision ID. Must not be null or empty.

Returns
Type Description
string

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

FromProjectLocationSpaceSharedTemplateRevision(string, string, string, string, string)

public static SharedTemplateRevisionName FromProjectLocationSpaceSharedTemplateRevision(string projectId, string locationId, string spaceId, string sharedTemplateId, string revisionId)

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

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.

revisionId string

The Revision ID. Must not be null or empty.

Returns
Type Description
SharedTemplateRevisionName

A new instance of SharedTemplateRevisionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SharedTemplateRevisionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SharedTemplateRevisionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
SharedTemplateRevisionName

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

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

Parameter
Name Description
sharedTemplateRevisionName string

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

Returns
Type Description
SharedTemplateRevisionName

The parsed SharedTemplateRevisionName 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}/revisions/{revision}

Parse(string, bool)

public static SharedTemplateRevisionName Parse(string sharedTemplateRevisionName, bool allowUnparsed)

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

Parameters
Name Description
sharedTemplateRevisionName 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
SharedTemplateRevisionName

The parsed SharedTemplateRevisionName 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}/revisions/{revision}

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

public static bool TryParse(string sharedTemplateRevisionName, out SharedTemplateRevisionName result)

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

Parameters
Name Description
sharedTemplateRevisionName string

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

result SharedTemplateRevisionName

When this method returns, the parsed SharedTemplateRevisionName, 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}/revisions/{revision}

TryParse(string, bool, out SharedTemplateRevisionName)

public static bool TryParse(string sharedTemplateRevisionName, bool allowUnparsed, out SharedTemplateRevisionName result)

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

Parameters
Name Description
sharedTemplateRevisionName 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 SharedTemplateRevisionName

When this method returns, the parsed SharedTemplateRevisionName, 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}/revisions/{revision}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SharedTemplateRevisionName, SharedTemplateRevisionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SharedTemplateRevisionName

The first resource name to compare, or null.

b SharedTemplateRevisionName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SharedTemplateRevisionName

The first resource name to compare, or null.

b SharedTemplateRevisionName

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.