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

public sealed class ComponentName : IResourceName, IEquatable<ComponentName>

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

Resource name for the Component resource.

Inheritance

object > ComponentName

Namespace

Google.Cloud.DesignCenter.V1

Assembly

Google.Cloud.DesignCenter.V1.dll

Constructors

ComponentName(string, string, string, string, string)

public ComponentName(string projectId, string locationId, string spaceId, string applicationTemplateId, string componentId)

Constructs a new instance of a ComponentName class from the component parts of pattern projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/components/{component}

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

The ApplicationTemplate ID. Must not be null or empty.
componentId string

The Component ID. Must not be null or empty.

Properties

ApplicationTemplateId

public string ApplicationTemplateId { get; }

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

Property Value
Type Description
string

ComponentId

public string ComponentId { get; }

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

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 ComponentName.ResourceNameType Type { get; }

The ComponentName.ResourceNameType of the contained resource name.

Property Value
Type Description
ComponentNameResourceNameType

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

Formats the IDs into the string representation of this ComponentName with pattern projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/components/{component} .

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

The ApplicationTemplate ID. Must not be null or empty.
componentId string

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

The string representation of this ComponentName with pattern projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/components/{component} .

FormatProjectLocationSpaceApplicationTemplateComponent(string, string, string, string, string)

public static string FormatProjectLocationSpaceApplicationTemplateComponent(string projectId, string locationId, string spaceId, string applicationTemplateId, string componentId)

Formats the IDs into the string representation of this ComponentName with pattern projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/components/{component} .

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

The ApplicationTemplate ID. Must not be null or empty.
componentId string

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

The string representation of this ComponentName with pattern projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/components/{component} .

FromProjectLocationSpaceApplicationTemplateComponent(string, string, string, string, string)

public static ComponentName FromProjectLocationSpaceApplicationTemplateComponent(string projectId, string locationId, string spaceId, string applicationTemplateId, string componentId)

Creates a ComponentName with the pattern projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/components/{component} .

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

The ApplicationTemplate ID. Must not be null or empty.
componentId string

The Component ID. Must not be null or empty.
Returns
Type Description
ComponentName

A new instance of ComponentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ComponentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ComponentName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
componentName string

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

The parsed ComponentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/components/{component}

Parse(string, bool)

public static ComponentName Parse(string componentName, bool allowUnparsed)

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

Parameters
Name Description
componentName 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
ComponentName

The parsed ComponentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/components/{component}

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

public static bool TryParse(string componentName, out ComponentName result)

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

Parameters
Name Description
componentName string

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

When this method returns, the parsed ComponentName, 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}/applicationTemplates/{application_template}/components/{component}

TryParse(string, bool, out ComponentName)

public static bool TryParse(string componentName, bool allowUnparsed, out ComponentName result)

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

Parameters
Name Description
componentName 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 ComponentName

When this method returns, the parsed ComponentName, 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}/applicationTemplates/{application_template}/components/{component}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ComponentName, ComponentName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ComponentName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ComponentName

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

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.