Network Security v1beta1 API - Class ClientTlsPolicyName (2.0.0-beta05)

public sealed class ClientTlsPolicyName : IResourceName, IEquatable<ClientTlsPolicyName>

Reference documentation and code samples for the Network Security v1beta1 API class ClientTlsPolicyName.

Resource name for the ClientTlsPolicy resource.

Inheritance

object > ClientTlsPolicyName

Namespace

Google.Cloud.NetworkSecurity.V1Beta1

Assembly

Google.Cloud.NetworkSecurity.V1Beta1.dll

Constructors

ClientTlsPolicyName(string, string, string)

public ClientTlsPolicyName(string projectId, string locationId, string clientTlsPolicyId)

Constructs a new instance of a ClientTlsPolicyName class from the component parts of pattern projects/{project}/locations/{location}/clientTlsPolicies/{client_tls_policy}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

clientTlsPolicyIdstring

The ClientTlsPolicy ID. Must not be null or empty.

Properties

ClientTlsPolicyId

public string ClientTlsPolicyId { get; }

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

Property Value
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
bool

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

Type

public ClientTlsPolicyName.ResourceNameType Type { get; }

The ClientTlsPolicyName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ClientTlsPolicyNameResourceNameType

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

Formats the IDs into the string representation of this ClientTlsPolicyName with pattern projects/{project}/locations/{location}/clientTlsPolicies/{client_tls_policy}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

clientTlsPolicyIdstring

The ClientTlsPolicy ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ClientTlsPolicyName with pattern projects/{project}/locations/{location}/clientTlsPolicies/{client_tls_policy}.

FormatProjectLocationClientTlsPolicy(string, string, string)

public static string FormatProjectLocationClientTlsPolicy(string projectId, string locationId, string clientTlsPolicyId)

Formats the IDs into the string representation of this ClientTlsPolicyName with pattern projects/{project}/locations/{location}/clientTlsPolicies/{client_tls_policy}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

clientTlsPolicyIdstring

The ClientTlsPolicy ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ClientTlsPolicyName with pattern projects/{project}/locations/{location}/clientTlsPolicies/{client_tls_policy}.

FromProjectLocationClientTlsPolicy(string, string, string)

public static ClientTlsPolicyName FromProjectLocationClientTlsPolicy(string projectId, string locationId, string clientTlsPolicyId)

Creates a ClientTlsPolicyName with the pattern projects/{project}/locations/{location}/clientTlsPolicies/{client_tls_policy}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

clientTlsPolicyIdstring

The ClientTlsPolicy ID. Must not be null or empty.

Returns
TypeDescription
ClientTlsPolicyName

A new instance of ClientTlsPolicyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ClientTlsPolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ClientTlsPolicyName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ClientTlsPolicyName

A new instance of ClientTlsPolicyName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static ClientTlsPolicyName Parse(string clientTlsPolicyName)

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

Parameter
NameDescription
clientTlsPolicyNamestring

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

Returns
TypeDescription
ClientTlsPolicyName

The parsed ClientTlsPolicyName if successful.

Remarks

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

  • projects/{project}/locations/{location}/clientTlsPolicies/{client_tls_policy}

Parse(string, bool)

public static ClientTlsPolicyName Parse(string clientTlsPolicyName, bool allowUnparsed)

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

Parameters
NameDescription
clientTlsPolicyNamestring

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

allowUnparsedbool

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
ClientTlsPolicyName

The parsed ClientTlsPolicyName if successful.

Remarks

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

  • projects/{project}/locations/{location}/clientTlsPolicies/{client_tls_policy}
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 ClientTlsPolicyName)

public static bool TryParse(string clientTlsPolicyName, out ClientTlsPolicyName result)

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

Parameters
NameDescription
clientTlsPolicyNamestring

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

resultClientTlsPolicyName

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

Returns
TypeDescription
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}/clientTlsPolicies/{client_tls_policy}

TryParse(string, bool, out ClientTlsPolicyName)

public static bool TryParse(string clientTlsPolicyName, bool allowUnparsed, out ClientTlsPolicyName result)

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

Parameters
NameDescription
clientTlsPolicyNamestring

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

allowUnparsedbool

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.

resultClientTlsPolicyName

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

Returns
TypeDescription
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}/clientTlsPolicies/{client_tls_policy}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ClientTlsPolicyName, ClientTlsPolicyName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aClientTlsPolicyName

The first resource name to compare, or null.

bClientTlsPolicyName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(ClientTlsPolicyName, ClientTlsPolicyName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aClientTlsPolicyName

The first resource name to compare, or null.

bClientTlsPolicyName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.