Google Cloud Deploy v1 API - Class TargetName (2.3.0)

Version 2.3.0

• 3.3.0 (latest)
• 3.2.0
• 3.1.0
• 3.0.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.1.0
• 1.0.0

public sealed class TargetName : IResourceName, IEquatable<TargetName>

Reference documentation and code samples for the Google Cloud Deploy v1 API class TargetName.

Resource name for the Target resource.

Inheritance

object > TargetName

Implements

IResourceName, IEquatableTargetName

Inherited Members

object.GetType()

Namespace

GoogleCloudGoogle.Cloud.DeployV1

Assembly

Google.Cloud.Deploy.V1.dll

Constructors

TargetName(string, string, string)

public TargetName(string projectId, string locationId, string targetId)

Constructs a new instance of a TargetName class from the component parts of pattern projects/{project}/locations/{location}/targets/{target}

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.
targetId	string The Target 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

TargetId

public string TargetId { get; }

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

Property Value
Type	Description
string

Type

public TargetName.ResourceNameType Type { get; }

The TargetName.ResourceNameType of the contained resource name.

Property Value
Type	Description
TargetNameResourceNameType

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)

public static string Format(string projectId, string locationId, string targetId)

Formats the IDs into the string representation of this TargetName with pattern projects/{project}/locations/{location}/targets/{target}.

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.
targetId	string The Target ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this TargetName with pattern projects/{project}/locations/{location}/targets/{target}.

FormatProjectLocationTarget(string, string, string)

public static string FormatProjectLocationTarget(string projectId, string locationId, string targetId)

Formats the IDs into the string representation of this TargetName with pattern projects/{project}/locations/{location}/targets/{target}.

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.
targetId	string The Target ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this TargetName with pattern projects/{project}/locations/{location}/targets/{target}.

FromProjectLocationTarget(string, string, string)

public static TargetName FromProjectLocationTarget(string projectId, string locationId, string targetId)

Creates a TargetName with the pattern projects/{project}/locations/{location}/targets/{target}.

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.
targetId	string The Target ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static TargetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TargetName containing an unparsed resource name.

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

Returns
Type	Description
TargetName	A new instance of TargetName 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 TargetName Parse(string targetName)

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

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

Returns
Type	Description
TargetName	The parsed TargetName if successful.

Remarks

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

• projects/{project}/locations/{location}/targets/{target}

Parse(string, bool)

public static TargetName Parse(string targetName, bool allowUnparsed)

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

Parameters
Name	Description
targetName	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
TargetName	The parsed TargetName if successful.

Remarks

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

• projects/{project}/locations/{location}/targets/{target}

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

public static bool TryParse(string targetName, out TargetName result)

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

Parameters
Name	Description
targetName	string The resource name in string form. Must not be null.
result	TargetName When this method returns, the parsed TargetName, 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}/targets/{target}

TryParse(string, bool, out TargetName)

public static bool TryParse(string targetName, bool allowUnparsed, out TargetName result)

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

Parameters
Name	Description
targetName	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	TargetName When this method returns, the parsed TargetName, 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}/targets/{target}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(TargetName, TargetName)

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

Parameters
Name	Description
a	TargetName
b	TargetName

Returns
Type	Description
bool

operator !=(TargetName, TargetName)

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

Parameters
Name	Description
a	TargetName
b	TargetName

Returns
Type	Description
bool