Discovery Engine v1beta API - Class AclConfigName (1.0.0-beta24)

1.0.0-beta24 (latest) 1.0.0-beta23

public sealed class AclConfigName : IResourceName, IEquatable<AclConfigName>

Reference documentation and code samples for the Discovery Engine v1beta API class AclConfigName.

Resource name for the AclConfig resource.

Inheritance

object > AclConfigName

Implements

IResourceName, IEquatableAclConfigName

Inherited Members

object.GetType()

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

AclConfigName(string, string)

public AclConfigName(string projectId, string locationId)

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

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

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 AclConfigName.ResourceNameType Type { get; }

The AclConfigName.ResourceNameType of the contained resource name.

Property Value
Type	Description
AclConfigNameResourceNameType

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 AclConfigName with pattern projects/{project}/locations/{location}/aclConfig.

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 AclConfigName with pattern projects/{project}/locations/{location}/aclConfig.

FormatProjectLocation(string, string)

public static string FormatProjectLocation(string projectId, string locationId)

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

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 AclConfigName with pattern projects/{project}/locations/{location}/aclConfig.

FromProjectLocation(string, string)

public static AclConfigName FromProjectLocation(string projectId, string locationId)

Creates a AclConfigName with the pattern projects/{project}/locations/{location}/aclConfig .

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
AclConfigName	A new instance of AclConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AclConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AclConfigName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
AclConfigName	A new instance of AclConfigName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static AclConfigName Parse(string aclConfigName)

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

Parameter
Name	Description
aclConfigName	string The resource name in string form. Must not be null.

Returns
Type	Description
AclConfigName	The parsed AclConfigName if successful.

Remarks

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

• projects/{project}/locations/{location}/aclConfig

Parse(string, bool)

public static AclConfigName Parse(string aclConfigName, bool allowUnparsed)

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

Parameters
Name	Description
aclConfigName	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
AclConfigName	The parsed AclConfigName if successful.

Remarks

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

• projects/{project}/locations/{location}/aclConfig

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

public static bool TryParse(string aclConfigName, out AclConfigName result)

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

Parameters
Name	Description
aclConfigName	string The resource name in string form. Must not be null.
result	AclConfigName When this method returns, the parsed AclConfigName, 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}/aclConfig

TryParse(string, bool, out AclConfigName)

public static bool TryParse(string aclConfigName, bool allowUnparsed, out AclConfigName result)

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

Parameters
Name	Description
aclConfigName	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	AclConfigName When this method returns, the parsed AclConfigName, 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}/aclConfig

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AclConfigName, AclConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	AclConfigName The first resource name to compare, or null.
b	AclConfigName 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 !=(AclConfigName, AclConfigName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	AclConfigName The first resource name to compare, or null.
b	AclConfigName 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.