Google Cloud Deploy v1 API - Class CustomTargetTypeName (2.16.0)

 public sealed class CustomTargetTypeName : IResourceName, IEquatable<CustomTargetTypeName>

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

Resource name for the CustomTargetType resource.

Inheritance

object > CustomTargetTypeName

Namespace

Google.Cloud.Deploy.V1

Assembly

Google.Cloud.Deploy.V1.dll

Constructors

CustomTargetTypeName(string, string, string)

 public CustomTargetTypeName(string projectId, string locationId, string customTargetTypeId)

Constructs a new instance of a CustomTargetTypeName class from the component parts of pattern projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}

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.

customTargetTypeId
string

The CustomTargetType ID. Must not be null or empty.

Properties

CustomTargetTypeId

 public string CustomTargetTypeId { get; }

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

Type

 public CustomTargetTypeName.ResourceNameType Type { get; }

The CustomTargetTypeName.ResourceNameType of the contained resource name.

Property Value
Type
Description
CustomTargetTypeName ResourceNameType

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

Formats the IDs into the string representation of this CustomTargetTypeName with pattern projects/{project}/locations/{location}/customTargetTypes/{custom_target_type} .

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.

customTargetTypeId
string

The CustomTargetType ID. Must not be null or empty.

Returns
Type
Description
string

The string representation of this CustomTargetTypeName with pattern projects/{project}/locations/{location}/customTargetTypes/{custom_target_type} .

FormatProjectLocationCustomTargetType(string, string, string)

 public static string FormatProjectLocationCustomTargetType(string projectId, string locationId, string customTargetTypeId)

Formats the IDs into the string representation of this CustomTargetTypeName with pattern projects/{project}/locations/{location}/customTargetTypes/{custom_target_type} .

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.

customTargetTypeId
string

The CustomTargetType ID. Must not be null or empty.

Returns
Type
Description
string

The string representation of this CustomTargetTypeName with pattern projects/{project}/locations/{location}/customTargetTypes/{custom_target_type} .

FromProjectLocationCustomTargetType(string, string, string)

 public static CustomTargetTypeName FromProjectLocationCustomTargetType(string projectId, string locationId, string customTargetTypeId)

Creates a CustomTargetTypeName with the pattern projects/{project}/locations/{location}/customTargetTypes/{custom_target_type} .

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.

customTargetTypeId
string

The CustomTargetType ID. Must not be null or empty.

Returns
Type
Description
CustomTargetTypeName

A new instance of CustomTargetTypeName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

 public static CustomTargetTypeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CustomTargetTypeName containing an unparsed resource name.

Parameter
Name
Description
unparsedResourceName
UnparsedResourceName

The unparsed resource name. Must not be null .

Returns
Type
Description
CustomTargetTypeName

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

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

Parameter
Name
Description
customTargetTypeName
string

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

Returns
Type
Description
CustomTargetTypeName

The parsed CustomTargetTypeName if successful.

Remarks

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

  • projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}

Parse(string, bool)

 public static CustomTargetTypeName Parse(string customTargetTypeName, bool allowUnparsed)

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

Parameters
Name
Description
customTargetTypeName
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
CustomTargetTypeName

The parsed CustomTargetTypeName if successful.

Remarks

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

  • projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}
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 CustomTargetTypeName)

 public static bool TryParse(string customTargetTypeName, out CustomTargetTypeName result)

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

Parameters
Name
Description
customTargetTypeName
string

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

result
CustomTargetTypeName

When this method returns, the parsed CustomTargetTypeName , 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}/customTargetTypes/{custom_target_type}

TryParse(string, bool, out CustomTargetTypeName)

 public static bool TryParse(string customTargetTypeName, bool allowUnparsed, out CustomTargetTypeName result)

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

Parameters
Name
Description
customTargetTypeName
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
CustomTargetTypeName

When this method returns, the parsed CustomTargetTypeName , 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}/customTargetTypes/{custom_target_type}
Or may be in any format if allowUnparsed is true .

Operators

operator ==(CustomTargetTypeName, CustomTargetTypeName)

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

Determines whether two specified resource names have the same value.

Parameters
Name
Description
a
CustomTargetTypeName

The first resource name to compare, or null.

b
CustomTargetTypeName

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

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

Determines whether two specified resource names have different values.

Parameters
Name
Description
a
CustomTargetTypeName

The first resource name to compare, or null.

b
CustomTargetTypeName

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.