Telco Automation v1 API - Class BlueprintName (1.0.0)

public sealed class BlueprintName : IResourceName, IEquatable<BlueprintName>

Reference documentation and code samples for the Telco Automation v1 API class BlueprintName.

Resource name for the Blueprint resource.

Inheritance

object > BlueprintName

Implements

IResourceName, IEquatable BlueprintName

Inherited Members

object.GetType()

Namespace

Google.Cloud.TelcoAutomation.V1

Assembly

Google.Cloud.TelcoAutomation.V1.dll

Constructors

BlueprintName(string, string, string, string)

public BlueprintName(string projectId, string locationId, string orchestrationClusterId, string blueprintId)

Constructs a new instance of a BlueprintName class from the component parts of pattern projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}/blueprints/{blueprint}

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.
`orchestrationClusterId`	`string` The `OrchestrationCluster` ID. Must not be `null` or empty.
`blueprintId`	`string` The `Blueprint` ID. Must not be `null` or empty.

Properties

BlueprintId

public string BlueprintId { get; }

The Blueprint 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`

OrchestrationClusterId

public string OrchestrationClusterId { get; }

The OrchestrationCluster 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`

Type

public BlueprintName.ResourceNameType Type { get; }

The BlueprintName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`BlueprintNameResourceNameType`

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

Formats the IDs into the string representation of this BlueprintName with pattern projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}/blueprints/{blueprint} .

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.
`orchestrationClusterId`	`string` The `OrchestrationCluster` ID. Must not be `null` or empty.
`blueprintId`	`string` The `Blueprint` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this BlueprintName with pattern `projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}/blueprints/{blueprint}` .

FormatProjectLocationOrchestrationClusterBlueprint(string, string, string, string)

public static string FormatProjectLocationOrchestrationClusterBlueprint(string projectId, string locationId, string orchestrationClusterId, string blueprintId)

Formats the IDs into the string representation of this BlueprintName with pattern projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}/blueprints/{blueprint} .

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.
`orchestrationClusterId`	`string` The `OrchestrationCluster` ID. Must not be `null` or empty.
`blueprintId`	`string` The `Blueprint` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this BlueprintName with pattern `projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}/blueprints/{blueprint}` .

FromProjectLocationOrchestrationClusterBlueprint(string, string, string, string)

public static BlueprintName FromProjectLocationOrchestrationClusterBlueprint(string projectId, string locationId, string orchestrationClusterId, string blueprintId)

Creates a BlueprintName with the pattern projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}/blueprints/{blueprint} .

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.
`orchestrationClusterId`	`string` The `OrchestrationCluster` ID. Must not be `null` or empty.
`blueprintId`	`string` The `Blueprint` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static BlueprintName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BlueprintName containing an unparsed resource name.

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

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

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static BlueprintName Parse(string blueprintName)

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

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

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

Remarks

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

projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}/blueprints/{blueprint}

Parse(string, bool)

public static BlueprintName Parse(string blueprintName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}/blueprints/{blueprint}

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

public static bool TryParse(string blueprintName, out BlueprintName result)

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

Parameters
Name	Description
`blueprintName`	`string` The resource name in string form. Must not be `null`.
`result`	`BlueprintName` When this method returns, the parsed BlueprintName, 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}/orchestrationClusters/{orchestration_cluster}/blueprints/{blueprint}

TryParse(string, bool, out BlueprintName)

public static bool TryParse(string blueprintName, bool allowUnparsed, out BlueprintName result)

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

Parameters
Name	Description
`blueprintName`	`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`	`BlueprintName` When this method returns, the parsed BlueprintName, 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}/orchestrationClusters/{orchestration_cluster}/blueprints/{blueprint}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(BlueprintName, BlueprintName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`BlueprintName` The first resource name to compare, or null.
`b`	`BlueprintName` 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 !=(BlueprintName, BlueprintName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`BlueprintName` The first resource name to compare, or null.
`b`	`BlueprintName` 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.