Network Services v1 API - Class ServerTlsPolicyName (1.0.0)

public sealed class ServerTlsPolicyName : IResourceName, IEquatable<ServerTlsPolicyName>

Reference documentation and code samples for the Network Services v1 API class ServerTlsPolicyName.

Resource name for the ServerTlsPolicy resource.

Inheritance

object > ServerTlsPolicyName

Namespace

Google.Cloud.NetworkServices.V1

Assembly

Google.Cloud.NetworkServices.V1.dll

Constructors

ServerTlsPolicyName(string, string, string)

public ServerTlsPolicyName(string projectId, string locationId, string serverTlsPolicyId)

Constructs a new instance of a ServerTlsPolicyName class from the component parts of pattern projects/{project}/locations/{location}/serverTlsPolicies/{server_tls_policy}

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.

serverTlsPolicyId string

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

ServerTlsPolicyId

public string ServerTlsPolicyId { get; }

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

Property Value
Type Description
string

Type

public ServerTlsPolicyName.ResourceNameType Type { get; }

The ServerTlsPolicyName.ResourceNameType of the contained resource name.

Property Value
Type Description
ServerTlsPolicyNameResourceNameType

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

Formats the IDs into the string representation of this ServerTlsPolicyName with pattern projects/{project}/locations/{location}/serverTlsPolicies/{server_tls_policy}.

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.

serverTlsPolicyId string

The ServerTlsPolicy ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ServerTlsPolicyName with pattern projects/{project}/locations/{location}/serverTlsPolicies/{server_tls_policy}.

FormatProjectLocationServerTlsPolicy(string, string, string)

public static string FormatProjectLocationServerTlsPolicy(string projectId, string locationId, string serverTlsPolicyId)

Formats the IDs into the string representation of this ServerTlsPolicyName with pattern projects/{project}/locations/{location}/serverTlsPolicies/{server_tls_policy}.

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.

serverTlsPolicyId string

The ServerTlsPolicy ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ServerTlsPolicyName with pattern projects/{project}/locations/{location}/serverTlsPolicies/{server_tls_policy}.

FromProjectLocationServerTlsPolicy(string, string, string)

public static ServerTlsPolicyName FromProjectLocationServerTlsPolicy(string projectId, string locationId, string serverTlsPolicyId)

Creates a ServerTlsPolicyName with the pattern projects/{project}/locations/{location}/serverTlsPolicies/{server_tls_policy}.

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.

serverTlsPolicyId string

The ServerTlsPolicy ID. Must not be null or empty.

Returns
Type Description
ServerTlsPolicyName

A new instance of ServerTlsPolicyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ServerTlsPolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ServerTlsPolicyName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
ServerTlsPolicyName

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

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

Parameter
Name Description
serverTlsPolicyName string

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

Returns
Type Description
ServerTlsPolicyName

The parsed ServerTlsPolicyName if successful.

Remarks

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

  • projects/{project}/locations/{location}/serverTlsPolicies/{server_tls_policy}

Parse(string, bool)

public static ServerTlsPolicyName Parse(string serverTlsPolicyName, bool allowUnparsed)

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

Parameters
Name Description
serverTlsPolicyName 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
ServerTlsPolicyName

The parsed ServerTlsPolicyName if successful.

Remarks

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

  • projects/{project}/locations/{location}/serverTlsPolicies/{server_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
Type Description
string

The string representation of the resource name.

Overrides

TryParse(string, out ServerTlsPolicyName)

public static bool TryParse(string serverTlsPolicyName, out ServerTlsPolicyName result)

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

Parameters
Name Description
serverTlsPolicyName string

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

result ServerTlsPolicyName

When this method returns, the parsed ServerTlsPolicyName, 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}/serverTlsPolicies/{server_tls_policy}

TryParse(string, bool, out ServerTlsPolicyName)

public static bool TryParse(string serverTlsPolicyName, bool allowUnparsed, out ServerTlsPolicyName result)

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

Parameters
Name Description
serverTlsPolicyName 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 ServerTlsPolicyName

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

Operators

operator ==(ServerTlsPolicyName, ServerTlsPolicyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ServerTlsPolicyName

The first resource name to compare, or null.

b ServerTlsPolicyName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ServerTlsPolicyName

The first resource name to compare, or null.

b ServerTlsPolicyName

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.