Model Armor v1beta API - Class FloorSettingName (1.0.0-beta01) 

public sealed class FloorSettingName : IResourceName, IEquatable<FloorSettingName>

Reference documentation and code samples for the Model Armor v1beta API class FloorSettingName.

Resource name for the FloorSetting resource.

Inheritance

object > FloorSettingName

Namespace

Google.Cloud.ModelArmor.V1Beta

Assembly

Google.Cloud.ModelArmor.V1Beta.dll

Constructors

FloorSettingName(string, string)

public FloorSettingName(string projectId, string locationId)

Constructs a new instance of a FloorSettingName class from the component parts of pattern projects/{project}/locations/{location}/floorSetting

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.

Properties

FolderId

public string FolderId { get; }

The Folder ID. May be null, depending on which resource name is contained by this instance.

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. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

OrganizationId

public string OrganizationId { get; }

The Organization ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

Type

public FloorSettingName.ResourceNameType Type { get; }

The FloorSettingName.ResourceNameType of the contained resource name.

Property Value
Type Description
FloorSettingNameResourceNameType

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)

public static string Format(string projectId, string locationId)

Formats the IDs into the string representation of this FloorSettingName with pattern projects/{project}/locations/{location}/floorSetting.

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.
Returns
Type Description
string

The string representation of this FloorSettingName with pattern projects/{project}/locations/{location}/floorSetting.

FormatFolderLocation(string, string)

public static string FormatFolderLocation(string folderId, string locationId)

Formats the IDs into the string representation of this FloorSettingName with pattern folders/{folder}/locations/{location}/floorSetting.

Parameters
Name Description
folderId string

The Folder ID. Must not be null or empty.
locationId string

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

The string representation of this FloorSettingName with pattern folders/{folder}/locations/{location}/floorSetting.

FormatOrganizationLocation(string, string)

public static string FormatOrganizationLocation(string organizationId, string locationId)

Formats the IDs into the string representation of this FloorSettingName with pattern organizations/{organization}/locations/{location}/floorSetting.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

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

The string representation of this FloorSettingName with pattern organizations/{organization}/locations/{location}/floorSetting.

FormatProjectLocation(string, string)

public static string FormatProjectLocation(string projectId, string locationId)

Formats the IDs into the string representation of this FloorSettingName with pattern projects/{project}/locations/{location}/floorSetting.

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.
Returns
Type Description
string

The string representation of this FloorSettingName with pattern projects/{project}/locations/{location}/floorSetting.

FromFolderLocation(string, string)

public static FloorSettingName FromFolderLocation(string folderId, string locationId)

Creates a FloorSettingName with the pattern folders/{folder}/locations/{location}/floorSetting.

Parameters
Name Description
folderId string

The Folder ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
Returns
Type Description
FloorSettingName

A new instance of FloorSettingName constructed from the provided ids.

FromOrganizationLocation(string, string)

public static FloorSettingName FromOrganizationLocation(string organizationId, string locationId)

Creates a FloorSettingName with the pattern organizations/{organization}/locations/{location}/floorSetting.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
Returns
Type Description
FloorSettingName

A new instance of FloorSettingName constructed from the provided ids.

FromProjectLocation(string, string)

public static FloorSettingName FromProjectLocation(string projectId, string locationId)

Creates a FloorSettingName with the pattern projects/{project}/locations/{location}/floorSetting.

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.
Returns
Type Description
FloorSettingName

A new instance of FloorSettingName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FloorSettingName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FloorSettingName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
floorSettingName string

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

The parsed FloorSettingName if successful.
Remarks

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

  • projects/{project}/locations/{location}/floorSetting
  • folders/{folder}/locations/{location}/floorSetting
  • organizations/{organization}/locations/{location}/floorSetting

Parse(string, bool)

public static FloorSettingName Parse(string floorSettingName, bool allowUnparsed)

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

Parameters
Name Description
floorSettingName 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
FloorSettingName

The parsed FloorSettingName if successful.
Remarks

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

  • projects/{project}/locations/{location}/floorSetting
  • folders/{folder}/locations/{location}/floorSetting
  • organizations/{organization}/locations/{location}/floorSetting
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 FloorSettingName)

public static bool TryParse(string floorSettingName, out FloorSettingName result)

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

Parameters
Name Description
floorSettingName string

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

When this method returns, the parsed FloorSettingName, 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}/floorSetting
  • folders/{folder}/locations/{location}/floorSetting
  • organizations/{organization}/locations/{location}/floorSetting

TryParse(string, bool, out FloorSettingName)

public static bool TryParse(string floorSettingName, bool allowUnparsed, out FloorSettingName result)

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

Parameters
Name Description
floorSettingName 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 FloorSettingName

When this method returns, the parsed FloorSettingName, 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}/floorSetting
  • folders/{folder}/locations/{location}/floorSetting
  • organizations/{organization}/locations/{location}/floorSetting
Or may be in any format if allowUnparsed is true.

Operators

operator ==(FloorSettingName, FloorSettingName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a FloorSettingName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a FloorSettingName

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

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.