Gemini Enterprise for Customer Experience v1 API - Class GuardrailName (1.0.0-beta01) 

public sealed class GuardrailName : IResourceName, IEquatable<GuardrailName>

Reference documentation and code samples for the Gemini Enterprise for Customer Experience v1 API class GuardrailName.

Resource name for the Guardrail resource.

Inheritance

object > GuardrailName

Namespace

Google.Cloud.Ces.V1

Assembly

Google.Cloud.Ces.V1.dll

Constructors

GuardrailName(string, string, string, string)

public GuardrailName(string projectId, string locationId, string appId, string guardrailId)

Constructs a new instance of a GuardrailName class from the component parts of pattern projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

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

The App ID. Must not be null or empty.
guardrailId string

The Guardrail ID. Must not be null or empty.

Properties

AppId

public string AppId { get; }

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

Property Value
Type Description
string

GuardrailId

public string GuardrailId { get; }

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

The GuardrailName.ResourceNameType of the contained resource name.

Property Value
Type Description
GuardrailNameResourceNameType

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

public static string Format(string projectId, string locationId, string appId, string guardrailId)

Formats the IDs into the string representation of this GuardrailName with pattern projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}.

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

The App ID. Must not be null or empty.
guardrailId string

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

The string representation of this GuardrailName with pattern projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}.

FormatProjectLocationAppGuardrail(string, string, string, string)

public static string FormatProjectLocationAppGuardrail(string projectId, string locationId, string appId, string guardrailId)

Formats the IDs into the string representation of this GuardrailName with pattern projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}.

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

The App ID. Must not be null or empty.
guardrailId string

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

The string representation of this GuardrailName with pattern projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}.

FromProjectLocationAppGuardrail(string, string, string, string)

public static GuardrailName FromProjectLocationAppGuardrail(string projectId, string locationId, string appId, string guardrailId)

Creates a GuardrailName with the pattern projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}.

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

The App ID. Must not be null or empty.
guardrailId string

The Guardrail ID. Must not be null or empty.
Returns
Type Description
GuardrailName

A new instance of GuardrailName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static GuardrailName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GuardrailName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
guardrailName string

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

The parsed GuardrailName if successful.
Remarks

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

  • projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

Parse(string, bool)

public static GuardrailName Parse(string guardrailName, bool allowUnparsed)

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

Parameters
Name Description
guardrailName 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
GuardrailName

The parsed GuardrailName if successful.
Remarks

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

  • projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
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 GuardrailName)

public static bool TryParse(string guardrailName, out GuardrailName result)

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

Parameters
Name Description
guardrailName string

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

When this method returns, the parsed GuardrailName, 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}/apps/{app}/guardrails/{guardrail}

TryParse(string, bool, out GuardrailName)

public static bool TryParse(string guardrailName, bool allowUnparsed, out GuardrailName result)

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

Parameters
Name Description
guardrailName 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 GuardrailName

When this method returns, the parsed GuardrailName, 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}/apps/{app}/guardrails/{guardrail}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(GuardrailName, GuardrailName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a GuardrailName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a GuardrailName

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

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.