Artifact Registry v1 API - Class RuleName (2.9.0)

public sealed class RuleName : IResourceName, IEquatable<RuleName>

Reference documentation and code samples for the Artifact Registry v1 API class RuleName.

Resource name for the Rule resource.

Inheritance

object > RuleName

Implements

IResourceName, IEquatable RuleName

Inherited Members

object.GetType()

Namespace

Google.Cloud.ArtifactRegistry.V1

Assembly

Google.Cloud.ArtifactRegistry.V1.dll

Constructors

RuleName(string, string, string, string)

public RuleName(string projectId, string locationId, string repositoryId, string ruleId)

Constructs a new instance of a RuleName class from the component parts of pattern projects/{project}/locations/{location}/repositories/{repository}/rules/{rule}

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.
`repositoryId`	`string` The `Repository` ID. Must not be `null` or empty.
`ruleId`	`string` The `Rule` 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`

RepositoryId

public string RepositoryId { get; }

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

Property Value
Type	Description
`string`

RuleId

public string RuleId { get; }

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

Property Value
Type	Description
`string`

Type

public RuleName.ResourceNameType Type { get; }

The RuleName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`RuleNameResourceNameType`

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

Formats the IDs into the string representation of this RuleName with pattern projects/{project}/locations/{location}/repositories/{repository}/rules/{rule}.

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.
`repositoryId`	`string` The `Repository` ID. Must not be `null` or empty.
`ruleId`	`string` The `Rule` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this RuleName with pattern `projects/{project}/locations/{location}/repositories/{repository}/rules/{rule}`.

FormatProjectLocationRepositoryRule(string, string, string, string)

public static string FormatProjectLocationRepositoryRule(string projectId, string locationId, string repositoryId, string ruleId)

Formats the IDs into the string representation of this RuleName with pattern projects/{project}/locations/{location}/repositories/{repository}/rules/{rule}.

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.
`repositoryId`	`string` The `Repository` ID. Must not be `null` or empty.
`ruleId`	`string` The `Rule` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this RuleName with pattern `projects/{project}/locations/{location}/repositories/{repository}/rules/{rule}`.

FromProjectLocationRepositoryRule(string, string, string, string)

public static RuleName FromProjectLocationRepositoryRule(string projectId, string locationId, string repositoryId, string ruleId)

Creates a RuleName with the pattern projects/{project}/locations/{location}/repositories/{repository}/rules/{rule}.

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.
`repositoryId`	`string` The `Repository` ID. Must not be `null` or empty.
`ruleId`	`string` The `Rule` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static RuleName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RuleName containing an unparsed resource name.

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

Returns
Type	Description
`RuleName`	A new instance of RuleName 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 RuleName Parse(string ruleName)

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

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

Returns
Type	Description
`RuleName`	The parsed RuleName if successful.

Remarks

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

projects/{project}/locations/{location}/repositories/{repository}/rules/{rule}

Parse(string, bool)

public static RuleName Parse(string ruleName, bool allowUnparsed)

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

Parameters
Name	Description
`ruleName`	`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
`RuleName`	The parsed RuleName if successful.

Remarks

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

projects/{project}/locations/{location}/repositories/{repository}/rules/{rule}

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

public static bool TryParse(string ruleName, out RuleName result)

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

Parameters
Name	Description
`ruleName`	`string` The resource name in string form. Must not be `null`.
`result`	`RuleName` When this method returns, the parsed RuleName, 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}/repositories/{repository}/rules/{rule}

TryParse(string, bool, out RuleName)

public static bool TryParse(string ruleName, bool allowUnparsed, out RuleName result)

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

Parameters
Name	Description
`ruleName`	`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`	`RuleName` When this method returns, the parsed RuleName, 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}/repositories/{repository}/rules/{rule}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(RuleName, RuleName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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