Class TargetName

public sealed class TargetName : IResourceName, IEquatable<TargetName>

Resource name for the Target resource.

Inheritance

Object > TargetName

Namespace

Google.Cloud.Deploy.V1

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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

targetIdString

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
TypeDescription
Boolean

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

TargetId

public string TargetId { get; }

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

Property Value
TypeDescription
String

Type

public TargetName.ResourceNameType Type { get; }

The TargetName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
TargetName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

targetIdString

The Target ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

targetIdString

The Target ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

targetIdString

The Target ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
TargetName

A new instance of TargetName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static TargetName Parse(string targetName)

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

Parameter
NameDescription
targetNameString

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

Returns
TypeDescription
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, Boolean)

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
NameDescription
targetNameString

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

allowUnparsedBoolean

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
TypeDescription
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
TypeDescription
String

The string representation of the resource name.

Overrides

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
NameDescription
targetNameString

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

resultTargetName

When this method returns, the parsed TargetName, or null if parsing failed.

Returns
TypeDescription
Boolean

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, Boolean, 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
NameDescription
targetNameString

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

allowUnparsedBoolean

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.

resultTargetName

When this method returns, the parsed TargetName, or null if parsing failed.

Returns
TypeDescription
Boolean

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

Equality(TargetName, TargetName)

public static bool operator ==(TargetName a, TargetName b)
Parameters
NameDescription
aTargetName
bTargetName
Returns
TypeDescription
Boolean

Inequality(TargetName, TargetName)

public static bool operator !=(TargetName a, TargetName b)
Parameters
NameDescription
aTargetName
bTargetName
Returns
TypeDescription
Boolean