Class TargetSslProxiesName (1.0.0-beta02)

public sealed class TargetSslProxiesName : IResourceName, IEquatable<TargetSslProxiesName>

Resource name for the TargetSslProxies resource.

Inheritance

Object > TargetSslProxiesName

Namespace

Google.Cloud.CertificateManager.V1

Assembly

Google.Cloud.CertificateManager.V1.dll

Constructors

TargetSslProxiesName(String, String, String)

public TargetSslProxiesName(string projectId, string locationId, string targetSslProxyId)

Constructs a new instance of a TargetSslProxiesName class from the component parts of pattern projects/{project}/locations/{location}/targetSslProxies/{target_ssl_proxy}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

targetSslProxyIdString

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

TargetSslProxyId

public string TargetSslProxyId { get; }

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

Property Value
TypeDescription
String

Type

public TargetSslProxiesName.ResourceNameType Type { get; }

The TargetSslProxiesName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
TargetSslProxiesName.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 targetSslProxyId)

Formats the IDs into the string representation of this TargetSslProxiesName with pattern projects/{project}/locations/{location}/targetSslProxies/{target_ssl_proxy}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

targetSslProxyIdString

The TargetSslProxy ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this TargetSslProxiesName with pattern projects/{project}/locations/{location}/targetSslProxies/{target_ssl_proxy}.

FormatProjectLocationTargetSslProxy(String, String, String)

public static string FormatProjectLocationTargetSslProxy(string projectId, string locationId, string targetSslProxyId)

Formats the IDs into the string representation of this TargetSslProxiesName with pattern projects/{project}/locations/{location}/targetSslProxies/{target_ssl_proxy}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

targetSslProxyIdString

The TargetSslProxy ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this TargetSslProxiesName with pattern projects/{project}/locations/{location}/targetSslProxies/{target_ssl_proxy}.

FromProjectLocationTargetSslProxy(String, String, String)

public static TargetSslProxiesName FromProjectLocationTargetSslProxy(string projectId, string locationId, string targetSslProxyId)

Creates a TargetSslProxiesName with the pattern projects/{project}/locations/{location}/targetSslProxies/{target_ssl_proxy}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

targetSslProxyIdString

The TargetSslProxy ID. Must not be null or empty.

Returns
TypeDescription
TargetSslProxiesName

A new instance of TargetSslProxiesName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TargetSslProxiesName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TargetSslProxiesName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
TargetSslProxiesName

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

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

Parameter
NameDescription
targetSslProxiesNameString

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

Returns
TypeDescription
TargetSslProxiesName

The parsed TargetSslProxiesName if successful.

Remarks

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

  • projects/{project}/locations/{location}/targetSslProxies/{target_ssl_proxy}

Parse(String, Boolean)

public static TargetSslProxiesName Parse(string targetSslProxiesName, bool allowUnparsed)

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

Parameters
NameDescription
targetSslProxiesNameString

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
TargetSslProxiesName

The parsed TargetSslProxiesName if successful.

Remarks

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

  • projects/{project}/locations/{location}/targetSslProxies/{target_ssl_proxy}
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 TargetSslProxiesName)

public static bool TryParse(string targetSslProxiesName, out TargetSslProxiesName result)

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

Parameters
NameDescription
targetSslProxiesNameString

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

resultTargetSslProxiesName

When this method returns, the parsed TargetSslProxiesName, 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}/targetSslProxies/{target_ssl_proxy}

TryParse(String, Boolean, out TargetSslProxiesName)

public static bool TryParse(string targetSslProxiesName, bool allowUnparsed, out TargetSslProxiesName result)

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

Parameters
NameDescription
targetSslProxiesNameString

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.

resultTargetSslProxiesName

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

Operators

Equality(TargetSslProxiesName, TargetSslProxiesName)

public static bool operator ==(TargetSslProxiesName a, TargetSslProxiesName b)
Parameters
NameDescription
aTargetSslProxiesName
bTargetSslProxiesName
Returns
TypeDescription
Boolean

Inequality(TargetSslProxiesName, TargetSslProxiesName)

public static bool operator !=(TargetSslProxiesName a, TargetSslProxiesName b)
Parameters
NameDescription
aTargetSslProxiesName
bTargetSslProxiesName
Returns
TypeDescription
Boolean