Class SecuritySettingsName (1.3.0)

public sealed class SecuritySettingsName : IResourceName, IEquatable<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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

securitySettingsIdString

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

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

SecuritySettingsId

public string SecuritySettingsId { get; }

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

Property Value
TypeDescription
String

Type

public SecuritySettingsName.ResourceNameType Type { get; }

The SecuritySettingsName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
SecuritySettingsName.ResourceNameType

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

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

securitySettingsIdString

The SecuritySettings ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

securitySettingsIdString

The SecuritySettings ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

securitySettingsIdString

The SecuritySettings ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
SecuritySettingsName

A new instance of SecuritySettingsName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static SecuritySettingsName Parse(string securitySettingsName)

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

Parameter
NameDescription
securitySettingsNameString

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

Returns
TypeDescription
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
NameDescription
securitySettingsNameString

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

allowUnparsedBoolean

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
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
TypeDescription
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
NameDescription
securitySettingsNameString

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

resultSecuritySettingsName

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

Returns
TypeDescription
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
NameDescription
securitySettingsNameString

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

allowUnparsedBoolean

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.

resultSecuritySettingsName

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

Returns
TypeDescription
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
NameDescription
aSecuritySettingsName
bSecuritySettingsName
Returns
TypeDescription
Boolean

Inequality(SecuritySettingsName, SecuritySettingsName)

public static bool operator !=(SecuritySettingsName a, SecuritySettingsName b)
Parameters
NameDescription
aSecuritySettingsName
bSecuritySettingsName
Returns
TypeDescription
Boolean