Dialogflow v3 API - Class SecuritySettingsName (2.24.0) 

public sealed class SecuritySettingsName : IResourceName, IEquatable<SecuritySettingsName>

Reference documentation and code samples for the Dialogflow v3 API class SecuritySettingsName.

Resource name for the SecuritySettings resource.

Inheritance

object > SecuritySettingsName

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

SecuritySettingsName(string, string, string)

public SecuritySettingsName(string projectId, string locationId, string securitySettingsId)

Constructs a new instance of a SecuritySettingsName class from the component parts of pattern projects/{project}/locations/{location}/securitySettings/{security_settings}

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.
securitySettingsId string

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

SecuritySettingsId

public string SecuritySettingsId { get; }

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

Property Value
Type Description
string

Type

public SecuritySettingsName.ResourceNameType Type { get; }

The SecuritySettingsName.ResourceNameType of the contained resource name.

Property Value
Type Description
SecuritySettingsNameResourceNameType

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

Formats the IDs into the string representation of this SecuritySettingsName with pattern projects/{project}/locations/{location}/securitySettings/{security_settings}.

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.
securitySettingsId string

The SecuritySettings ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this SecuritySettingsName with pattern projects/{project}/locations/{location}/securitySettings/{security_settings}.

FormatProjectLocationSecuritySettings(string, string, string)

public static string FormatProjectLocationSecuritySettings(string projectId, string locationId, string securitySettingsId)

Formats the IDs into the string representation of this SecuritySettingsName with pattern projects/{project}/locations/{location}/securitySettings/{security_settings}.

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.
securitySettingsId string

The SecuritySettings ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this SecuritySettingsName with pattern projects/{project}/locations/{location}/securitySettings/{security_settings}.

FromProjectLocationSecuritySettings(string, string, string)

public static SecuritySettingsName FromProjectLocationSecuritySettings(string projectId, string locationId, string securitySettingsId)

Creates a SecuritySettingsName with the pattern projects/{project}/locations/{location}/securitySettings/{security_settings}.

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.
securitySettingsId string

The SecuritySettings ID. Must not be null or empty.
Returns
Type Description
SecuritySettingsName

A new instance of SecuritySettingsName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SecuritySettingsName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SecuritySettingsName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
SecuritySettingsName

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

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

Parameter
Name Description
securitySettingsName string

The resource name in string form. Must not be null.
Returns
Type Description
SecuritySettingsName

The parsed SecuritySettingsName if successful.
Remarks

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

  • projects/{project}/locations/{location}/securitySettings/{security_settings}

Parse(string, bool)

public static SecuritySettingsName Parse(string securitySettingsName, bool allowUnparsed)

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

Parameters
Name Description
securitySettingsName 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
SecuritySettingsName

The parsed SecuritySettingsName if successful.
Remarks

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

  • projects/{project}/locations/{location}/securitySettings/{security_settings}
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 SecuritySettingsName)

public static bool TryParse(string securitySettingsName, out SecuritySettingsName result)

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

Parameters
Name Description
securitySettingsName string

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

When this method returns, the parsed SecuritySettingsName, 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}/securitySettings/{security_settings}

TryParse(string, bool, out SecuritySettingsName)

public static bool TryParse(string securitySettingsName, bool allowUnparsed, out SecuritySettingsName result)

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

Parameters
Name Description
securitySettingsName 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 SecuritySettingsName

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

Operators

operator ==(SecuritySettingsName, SecuritySettingsName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SecuritySettingsName

The first resource name to compare, or null.
b SecuritySettingsName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SecuritySettingsName

The first resource name to compare, or null.
b SecuritySettingsName

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.