Policy Simulator v1 API - Class ReplayName (1.1.0)

public sealed class ReplayName : IResourceName, IEquatable<ReplayName>

Reference documentation and code samples for the Policy Simulator v1 API class ReplayName.

Resource name for the Replay resource.

Inheritance

object > ReplayName

Implements

IResourceName, IEquatable ReplayName

Inherited Members

object.GetType()

Namespace

Google.Cloud.PolicySimulator.V1

Assembly

Google.Cloud.PolicySimulator.V1.dll

Constructors

ReplayName(string, string, string)

public ReplayName(string projectId, string locationId, string replayId)

Constructs a new instance of a ReplayName class from the component parts of pattern projects/{project}/locations/{location}/replays/{replay}

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.
`replayId`	`string` The `Replay` 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`

ReplayId

public string ReplayId { get; }

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

Property Value
Type	Description
`string`

Type

public ReplayName.ResourceNameType Type { get; }

The ReplayName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ReplayNameResourceNameType`

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 projectId, string locationId, string replayId)

Formats the IDs into the string representation of this ReplayName with pattern projects/{project}/locations/{location}/replays/{replay}.

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.
`replayId`	`string` The `Replay` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ReplayName with pattern `projects/{project}/locations/{location}/replays/{replay}`.

FormatFolderLocationReplay(string, string, string)

public static string FormatFolderLocationReplay(string folderId, string locationId, string replayId)

Formats the IDs into the string representation of this ReplayName with pattern folders/{folder}/locations/{location}/replays/{replay}.

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.
`replayId`	`string` The `Replay` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ReplayName with pattern `folders/{folder}/locations/{location}/replays/{replay}`.

FormatOrganizationLocationReplay(string, string, string)

public static string FormatOrganizationLocationReplay(string organizationId, string locationId, string replayId)

Formats the IDs into the string representation of this ReplayName with pattern organizations/{organization}/locations/{location}/replays/{replay}.

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.
`replayId`	`string` The `Replay` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ReplayName with pattern `organizations/{organization}/locations/{location}/replays/{replay}`.

FormatProjectLocationReplay(string, string, string)

public static string FormatProjectLocationReplay(string projectId, string locationId, string replayId)

Formats the IDs into the string representation of this ReplayName with pattern projects/{project}/locations/{location}/replays/{replay}.

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.
`replayId`	`string` The `Replay` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ReplayName with pattern `projects/{project}/locations/{location}/replays/{replay}`.

FromFolderLocationReplay(string, string, string)

public static ReplayName FromFolderLocationReplay(string folderId, string locationId, string replayId)

Creates a ReplayName with the pattern folders/{folder}/locations/{location}/replays/{replay}.

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.
`replayId`	`string` The `Replay` ID. Must not be `null` or empty.

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

FromOrganizationLocationReplay(string, string, string)

public static ReplayName FromOrganizationLocationReplay(string organizationId, string locationId, string replayId)

Creates a ReplayName with the pattern organizations/{organization}/locations/{location}/replays/{replay}.

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.
`replayId`	`string` The `Replay` ID. Must not be `null` or empty.

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

FromProjectLocationReplay(string, string, string)

public static ReplayName FromProjectLocationReplay(string projectId, string locationId, string replayId)

Creates a ReplayName with the pattern projects/{project}/locations/{location}/replays/{replay}.

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.
`replayId`	`string` The `Replay` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static ReplayName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ReplayName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/replays/{replay}
folders/{folder}/locations/{location}/replays/{replay}
organizations/{organization}/locations/{location}/replays/{replay}

Parse(string, bool)

public static ReplayName Parse(string replayName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/replays/{replay}
folders/{folder}/locations/{location}/replays/{replay}
organizations/{organization}/locations/{location}/replays/{replay}

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

public static bool TryParse(string replayName, out ReplayName result)

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

Parameters
Name	Description
`replayName`	`string` The resource name in string form. Must not be `null`.
`result`	`ReplayName` When this method returns, the parsed ReplayName, 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}/replays/{replay}
folders/{folder}/locations/{location}/replays/{replay}
organizations/{organization}/locations/{location}/replays/{replay}

TryParse(string, bool, out ReplayName)

public static bool TryParse(string replayName, bool allowUnparsed, out ReplayName result)

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

Parameters
Name	Description
`replayName`	`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`	`ReplayName` When this method returns, the parsed ReplayName, 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}/replays/{replay}
folders/{folder}/locations/{location}/replays/{replay}
organizations/{organization}/locations/{location}/replays/{replay}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ReplayName, ReplayName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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