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

1.0.0-beta24 (latest) 1.0.0-beta23

public sealed class ContentPolicyName : IResourceName, IEquatable<ContentPolicyName>

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

Resource name for the ContentPolicy resource.

Inheritance

object > ContentPolicyName

Implements

IResourceName, IEquatableContentPolicyName

Inherited Members

object.GetType()

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

ContentPolicyName(string, string, string)

public ContentPolicyName(string organizationId, string locationId, string contentPolicyId)

Constructs a new instance of a ContentPolicyName class from the component parts of pattern organizations/{organization}/locations/{location}/contentPolicies/{content_policy}

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.
contentPolicyId	string The ContentPolicy ID. Must not be null or empty.

Properties

ContentPolicyId

public string ContentPolicyId { get; }

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

The ContentPolicyName.ResourceNameType of the contained resource name.

Property Value
Type	Description
ContentPolicyNameResourceNameType

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)

public static string Format(string organizationId, string locationId, string contentPolicyId)

Formats the IDs into the string representation of this ContentPolicyName with pattern organizations/{organization}/locations/{location}/contentPolicies/{content_policy}.

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.
contentPolicyId	string The ContentPolicy ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this ContentPolicyName with pattern organizations/{organization}/locations/{location}/contentPolicies/{content_policy}.

FormatOrganizationLocationContentPolicy(string, string, string)

public static string FormatOrganizationLocationContentPolicy(string organizationId, string locationId, string contentPolicyId)

Formats the IDs into the string representation of this ContentPolicyName with pattern organizations/{organization}/locations/{location}/contentPolicies/{content_policy}.

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.
contentPolicyId	string The ContentPolicy ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this ContentPolicyName with pattern organizations/{organization}/locations/{location}/contentPolicies/{content_policy}.

FormatProjectLocationContentPolicy(string, string, string)

public static string FormatProjectLocationContentPolicy(string projectId, string locationId, string contentPolicyId)

Formats the IDs into the string representation of this ContentPolicyName with pattern projects/{project}/locations/{location}/contentPolicies/{content_policy}.

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.
contentPolicyId	string The ContentPolicy ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this ContentPolicyName with pattern projects/{project}/locations/{location}/contentPolicies/{content_policy}.

FromOrganizationLocationContentPolicy(string, string, string)

public static ContentPolicyName FromOrganizationLocationContentPolicy(string organizationId, string locationId, string contentPolicyId)

Creates a ContentPolicyName with the pattern organizations/{organization}/locations/{location}/contentPolicies/{content_policy}.

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.
contentPolicyId	string The ContentPolicy ID. Must not be null or empty.

Returns
Type	Description
ContentPolicyName	A new instance of ContentPolicyName constructed from the provided ids.

FromProjectLocationContentPolicy(string, string, string)

public static ContentPolicyName FromProjectLocationContentPolicy(string projectId, string locationId, string contentPolicyId)

Creates a ContentPolicyName with the pattern projects/{project}/locations/{location}/contentPolicies/{content_policy}.

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.
contentPolicyId	string The ContentPolicy ID. Must not be null or empty.

Returns
Type	Description
ContentPolicyName	A new instance of ContentPolicyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ContentPolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ContentPolicyName containing an unparsed resource name.

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

Returns
Type	Description
ContentPolicyName	A new instance of ContentPolicyName 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 ContentPolicyName Parse(string contentPolicyName)

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

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

Returns
Type	Description
ContentPolicyName	The parsed ContentPolicyName if successful.

Remarks

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

• organizations/{organization}/locations/{location}/contentPolicies/{content_policy}
• projects/{project}/locations/{location}/contentPolicies/{content_policy}

Parse(string, bool)

public static ContentPolicyName Parse(string contentPolicyName, bool allowUnparsed)

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

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

Remarks

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

• organizations/{organization}/locations/{location}/contentPolicies/{content_policy}
• projects/{project}/locations/{location}/contentPolicies/{content_policy}

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

public static bool TryParse(string contentPolicyName, out ContentPolicyName result)

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

Parameters
Name	Description
contentPolicyName	string The resource name in string form. Must not be null.
result	ContentPolicyName When this method returns, the parsed ContentPolicyName, 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:

• organizations/{organization}/locations/{location}/contentPolicies/{content_policy}
• projects/{project}/locations/{location}/contentPolicies/{content_policy}

TryParse(string, bool, out ContentPolicyName)

public static bool TryParse(string contentPolicyName, bool allowUnparsed, out ContentPolicyName result)

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

Parameters
Name	Description
contentPolicyName	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	ContentPolicyName When this method returns, the parsed ContentPolicyName, 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:

• organizations/{organization}/locations/{location}/contentPolicies/{content_policy}
• projects/{project}/locations/{location}/contentPolicies/{content_policy}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ContentPolicyName, ContentPolicyName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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