Google Cloud Dialogflow v2 API - Class CXSecuritySettingsName (4.5.0)

public sealed class CXSecuritySettingsName : IResourceName, IEquatable<CXSecuritySettingsName>

Reference documentation and code samples for the Google Cloud Dialogflow v2 API class CXSecuritySettingsName.

Resource name for the CXSecuritySettings resource.

Inheritance

Object > CXSecuritySettingsName

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

CXSecuritySettingsName(String, String, String)

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

Constructs a new instance of a CXSecuritySettingsName 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 CXSecuritySettingsName.ResourceNameType Type { get; }

The CXSecuritySettingsName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
CXSecuritySettingsName.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 CXSecuritySettingsName 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 CXSecuritySettingsName 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 CXSecuritySettingsName 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 CXSecuritySettingsName with pattern projects/{project}/locations/{location}/securitySettings/{security_settings}.

FromProjectLocationSecuritySettings(String, String, String)

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

Creates a CXSecuritySettingsName 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
CXSecuritySettingsName

A new instance of CXSecuritySettingsName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CXSecuritySettingsName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CXSecuritySettingsName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
CXSecuritySettingsName

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

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

Parameter
NameDescription
cXSecuritySettingsNameString

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

Returns
TypeDescription
CXSecuritySettingsName

The parsed CXSecuritySettingsName 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 CXSecuritySettingsName Parse(string cXSecuritySettingsName, bool allowUnparsed)

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

Parameters
NameDescription
cXSecuritySettingsNameString

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
CXSecuritySettingsName

The parsed CXSecuritySettingsName 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 CXSecuritySettingsName)

public static bool TryParse(string cXSecuritySettingsName, out CXSecuritySettingsName result)

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

Parameters
NameDescription
cXSecuritySettingsNameString

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

resultCXSecuritySettingsName

When this method returns, the parsed CXSecuritySettingsName, 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 CXSecuritySettingsName)

public static bool TryParse(string cXSecuritySettingsName, bool allowUnparsed, out CXSecuritySettingsName result)

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

Parameters
NameDescription
cXSecuritySettingsNameString

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.

resultCXSecuritySettingsName

When this method returns, the parsed CXSecuritySettingsName, 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(CXSecuritySettingsName, CXSecuritySettingsName)

public static bool operator ==(CXSecuritySettingsName a, CXSecuritySettingsName b)
Parameters
NameDescription
aCXSecuritySettingsName
bCXSecuritySettingsName
Returns
TypeDescription
Boolean

Inequality(CXSecuritySettingsName, CXSecuritySettingsName)

public static bool operator !=(CXSecuritySettingsName a, CXSecuritySettingsName b)
Parameters
NameDescription
aCXSecuritySettingsName
bCXSecuritySettingsName
Returns
TypeDescription
Boolean