Binary Authorization v1 API - Class AttestorName (2.4.0)

public sealed class AttestorName : IResourceName, IEquatable<AttestorName>

Reference documentation and code samples for the Binary Authorization v1 API class AttestorName.

Resource name for the Attestor resource.

Inheritance

object > AttestorName

Implements

IResourceName, IEquatable AttestorName

Inherited Members

object.GetType()

Namespace

Google.Cloud.BinaryAuthorization.V1

Assembly

Google.Cloud.BinaryAuthorization.V1.dll

Constructors

AttestorName(string, string)

public AttestorName(string projectId, string attestorId)

Constructs a new instance of a AttestorName class from the component parts of pattern projects/{project}/attestors/{attestor}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`attestorId`	`string` The `Attestor` ID. Must not be `null` or empty.

Properties

AttestorId

public string AttestorId { get; }

The Attestor 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`

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

The AttestorName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`AttestorNameResourceNameType`

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

Formats the IDs into the string representation of this AttestorName with pattern projects/{project}/attestors/{attestor}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`attestorId`	`string` The `Attestor` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AttestorName with pattern `projects/{project}/attestors/{attestor}`.

FormatProjectAttestor(string, string)

public static string FormatProjectAttestor(string projectId, string attestorId)

Formats the IDs into the string representation of this AttestorName with pattern projects/{project}/attestors/{attestor}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`attestorId`	`string` The `Attestor` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AttestorName with pattern `projects/{project}/attestors/{attestor}`.

FromProjectAttestor(string, string)

public static AttestorName FromProjectAttestor(string projectId, string attestorId)

Creates a AttestorName with the pattern projects/{project}/attestors/{attestor}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`attestorId`	`string` The `Attestor` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static AttestorName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AttestorName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/attestors/{attestor}

Parse(string, bool)

public static AttestorName Parse(string attestorName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/attestors/{attestor}

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

public static bool TryParse(string attestorName, out AttestorName result)

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

Parameters
Name	Description
`attestorName`	`string` The resource name in string form. Must not be `null`.
`result`	`AttestorName` When this method returns, the parsed AttestorName, 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}/attestors/{attestor}

TryParse(string, bool, out AttestorName)

public static bool TryParse(string attestorName, bool allowUnparsed, out AttestorName result)

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

Parameters
Name	Description
`attestorName`	`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`	`AttestorName` When this method returns, the parsed AttestorName, 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}/attestors/{attestor}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AttestorName, AttestorName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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