Network Security v1 API - Class BackendAuthenticationConfigName (1.0.0-beta01)

public sealed class BackendAuthenticationConfigName : IResourceName, IEquatable<BackendAuthenticationConfigName>

Reference documentation and code samples for the Network Security v1 API class BackendAuthenticationConfigName.

Resource name for the BackendAuthenticationConfig resource.

Inheritance

object > BackendAuthenticationConfigName

Namespace

Google.Cloud.NetworkSecurity.V1

Assembly

Google.Cloud.NetworkSecurity.V1.dll

Constructors

BackendAuthenticationConfigName(string, string, string)

public BackendAuthenticationConfigName(string projectId, string locationId, string backendAuthenticationConfigId)

Constructs a new instance of a BackendAuthenticationConfigName class from the component parts of pattern projects/{project}/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}

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.

backendAuthenticationConfigId string

The BackendAuthenticationConfig ID. Must not be null or empty.

Properties

BackendAuthenticationConfigId

public string BackendAuthenticationConfigId { get; }

The BackendAuthenticationConfig 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 BackendAuthenticationConfigName.ResourceNameType Type { get; }

The BackendAuthenticationConfigName.ResourceNameType of the contained resource name.

Property Value
Type Description
BackendAuthenticationConfigNameResourceNameType

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

Formats the IDs into the string representation of this BackendAuthenticationConfigName with pattern projects/{project}/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}.

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.

backendAuthenticationConfigId string

The BackendAuthenticationConfig ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this BackendAuthenticationConfigName with pattern projects/{project}/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}.

FormatProjectLocationBackendAuthenticationConfig(string, string, string)

public static string FormatProjectLocationBackendAuthenticationConfig(string projectId, string locationId, string backendAuthenticationConfigId)

Formats the IDs into the string representation of this BackendAuthenticationConfigName with pattern projects/{project}/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}.

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.

backendAuthenticationConfigId string

The BackendAuthenticationConfig ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this BackendAuthenticationConfigName with pattern projects/{project}/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}.

FromProjectLocationBackendAuthenticationConfig(string, string, string)

public static BackendAuthenticationConfigName FromProjectLocationBackendAuthenticationConfig(string projectId, string locationId, string backendAuthenticationConfigId)

Creates a BackendAuthenticationConfigName with the pattern projects/{project}/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}.

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.

backendAuthenticationConfigId string

The BackendAuthenticationConfig ID. Must not be null or empty.

Returns
Type Description
BackendAuthenticationConfigName

A new instance of BackendAuthenticationConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static BackendAuthenticationConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BackendAuthenticationConfigName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
BackendAuthenticationConfigName

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

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

Parameter
Name Description
backendAuthenticationConfigName string

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

Returns
Type Description
BackendAuthenticationConfigName

The parsed BackendAuthenticationConfigName if successful.

Remarks

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

  • projects/{project}/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}

Parse(string, bool)

public static BackendAuthenticationConfigName Parse(string backendAuthenticationConfigName, bool allowUnparsed)

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

Parameters
Name Description
backendAuthenticationConfigName 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
BackendAuthenticationConfigName

The parsed BackendAuthenticationConfigName if successful.

Remarks

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

  • projects/{project}/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}

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

public static bool TryParse(string backendAuthenticationConfigName, out BackendAuthenticationConfigName result)

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

Parameters
Name Description
backendAuthenticationConfigName string

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

result BackendAuthenticationConfigName

When this method returns, the parsed BackendAuthenticationConfigName, 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}/backendAuthenticationConfigs/{backend_authentication_config}

TryParse(string, bool, out BackendAuthenticationConfigName)

public static bool TryParse(string backendAuthenticationConfigName, bool allowUnparsed, out BackendAuthenticationConfigName result)

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

Parameters
Name Description
backendAuthenticationConfigName 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 BackendAuthenticationConfigName

When this method returns, the parsed BackendAuthenticationConfigName, 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}/backendAuthenticationConfigs/{backend_authentication_config}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(BackendAuthenticationConfigName, BackendAuthenticationConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a BackendAuthenticationConfigName

The first resource name to compare, or null.

b BackendAuthenticationConfigName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a BackendAuthenticationConfigName

The first resource name to compare, or null.

b BackendAuthenticationConfigName

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.