Dialogflow v3 API - Class SecuritySettingsName (2.5.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

Implements

IResourceName, IEquatable<SecuritySettingsName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
`Boolean`

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
`SecuritySettingsName.ResourceNameType`

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
`Int32`

Overrides

Object.GetHashCode()

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, Boolean)

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`	`Boolean` 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

Object.ToString()

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
`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}/securitySettings/{security_settings}

TryParse(String, Boolean, 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`	`Boolean` 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
`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}/securitySettings/{security_settings}

Or may be in any format if allowUnparsed is true.

Operators

Equality(SecuritySettingsName, SecuritySettingsName)

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

Parameters
Name	Description
`a`	`SecuritySettingsName`
`b`	`SecuritySettingsName`

Returns
Type	Description
`Boolean`

Inequality(SecuritySettingsName, SecuritySettingsName)

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

Parameters
Name	Description
`a`	`SecuritySettingsName`
`b`	`SecuritySettingsName`

Returns
Type	Description
`Boolean`