Policy Simulator v1 API - Class ReplayResultName (1.0.0)

public sealed class ReplayResultName : IResourceName, IEquatable<ReplayResultName>

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

Resource name for the ReplayResult resource.

Inheritance

object > ReplayResultName

Namespace

Google.Cloud.PolicySimulator.V1

Assembly

Google.Cloud.PolicySimulator.V1.dll

Constructors

ReplayResultName(string, string, string, string)

public ReplayResultName(string projectId, string locationId, string replayId, string replayResultId)

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

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

replayIdstring

The Replay ID. Must not be null or empty.

replayResultIdstring

The ReplayResult 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
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
bool

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

OrganizationId

public string OrganizationId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

ReplayId

public string ReplayId { get; }

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

Property Value
TypeDescription
string

ReplayResultId

public string ReplayResultId { get; }

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

Property Value
TypeDescription
string

Type

public ReplayResultName.ResourceNameType Type { get; }

The ReplayResultName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ReplayResultNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string replayId, string replayResultId)

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

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

replayIdstring

The Replay ID. Must not be null or empty.

replayResultIdstring

The ReplayResult ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ReplayResultName with pattern projects/{project}/locations/{location}/replays/{replay}/results/{replay_result}.

FormatFolderLocationReplayReplayResult(string, string, string, string)

public static string FormatFolderLocationReplayReplayResult(string folderId, string locationId, string replayId, string replayResultId)

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

Parameters
NameDescription
folderIdstring

The Folder ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

replayIdstring

The Replay ID. Must not be null or empty.

replayResultIdstring

The ReplayResult ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ReplayResultName with pattern folders/{folder}/locations/{location}/replays/{replay}/results/{replay_result}.

FormatOrganizationLocationReplayReplayResult(string, string, string, string)

public static string FormatOrganizationLocationReplayReplayResult(string organizationId, string locationId, string replayId, string replayResultId)

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

Parameters
NameDescription
organizationIdstring

The Organization ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

replayIdstring

The Replay ID. Must not be null or empty.

replayResultIdstring

The ReplayResult ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ReplayResultName with pattern organizations/{organization}/locations/{location}/replays/{replay}/results/{replay_result}.

FormatProjectLocationReplayReplayResult(string, string, string, string)

public static string FormatProjectLocationReplayReplayResult(string projectId, string locationId, string replayId, string replayResultId)

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

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

replayIdstring

The Replay ID. Must not be null or empty.

replayResultIdstring

The ReplayResult ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ReplayResultName with pattern projects/{project}/locations/{location}/replays/{replay}/results/{replay_result}.

FromFolderLocationReplayReplayResult(string, string, string, string)

public static ReplayResultName FromFolderLocationReplayReplayResult(string folderId, string locationId, string replayId, string replayResultId)

Creates a ReplayResultName with the pattern folders/{folder}/locations/{location}/replays/{replay}/results/{replay_result}.

Parameters
NameDescription
folderIdstring

The Folder ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

replayIdstring

The Replay ID. Must not be null or empty.

replayResultIdstring

The ReplayResult ID. Must not be null or empty.

Returns
TypeDescription
ReplayResultName

A new instance of ReplayResultName constructed from the provided ids.

FromOrganizationLocationReplayReplayResult(string, string, string, string)

public static ReplayResultName FromOrganizationLocationReplayReplayResult(string organizationId, string locationId, string replayId, string replayResultId)

Creates a ReplayResultName with the pattern organizations/{organization}/locations/{location}/replays/{replay}/results/{replay_result}.

Parameters
NameDescription
organizationIdstring

The Organization ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

replayIdstring

The Replay ID. Must not be null or empty.

replayResultIdstring

The ReplayResult ID. Must not be null or empty.

Returns
TypeDescription
ReplayResultName

A new instance of ReplayResultName constructed from the provided ids.

FromProjectLocationReplayReplayResult(string, string, string, string)

public static ReplayResultName FromProjectLocationReplayReplayResult(string projectId, string locationId, string replayId, string replayResultId)

Creates a ReplayResultName with the pattern projects/{project}/locations/{location}/replays/{replay}/results/{replay_result}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

replayIdstring

The Replay ID. Must not be null or empty.

replayResultIdstring

The ReplayResult ID. Must not be null or empty.

Returns
TypeDescription
ReplayResultName

A new instance of ReplayResultName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ReplayResultName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ReplayResultName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ReplayResultName

A new instance of ReplayResultName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static ReplayResultName Parse(string replayResultName)

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

Parameter
NameDescription
replayResultNamestring

The resource name in string form. Must not be null.

Returns
TypeDescription
ReplayResultName

The parsed ReplayResultName if successful.

Remarks

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

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

Parse(string, bool)

public static ReplayResultName Parse(string replayResultName, bool allowUnparsed)

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

Parameters
NameDescription
replayResultNamestring

The resource name in string form. Must not be null.

allowUnparsedbool

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
TypeDescription
ReplayResultName

The parsed ReplayResultName if successful.

Remarks

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

  • projects/{project}/locations/{location}/replays/{replay}/results/{replay_result}
  • folders/{folder}/locations/{location}/replays/{replay}/results/{replay_result}
  • organizations/{organization}/locations/{location}/replays/{replay}/results/{replay_result}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
string

The string representation of the resource name.

Overrides

TryParse(string, out ReplayResultName)

public static bool TryParse(string replayResultName, out ReplayResultName result)

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

Parameters
NameDescription
replayResultNamestring

The resource name in string form. Must not be null.

resultReplayResultName

When this method returns, the parsed ReplayResultName, or null if parsing failed.

Returns
TypeDescription
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}/results/{replay_result}
  • folders/{folder}/locations/{location}/replays/{replay}/results/{replay_result}
  • organizations/{organization}/locations/{location}/replays/{replay}/results/{replay_result}

TryParse(string, bool, out ReplayResultName)

public static bool TryParse(string replayResultName, bool allowUnparsed, out ReplayResultName result)

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

Parameters
NameDescription
replayResultNamestring

The resource name in string form. Must not be null.

allowUnparsedbool

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.

resultReplayResultName

When this method returns, the parsed ReplayResultName, or null if parsing failed.

Returns
TypeDescription
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}/results/{replay_result}
  • folders/{folder}/locations/{location}/replays/{replay}/results/{replay_result}
  • organizations/{organization}/locations/{location}/replays/{replay}/results/{replay_result}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ReplayResultName, ReplayResultName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aReplayResultName

The first resource name to compare, or null.

bReplayResultName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(ReplayResultName, ReplayResultName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aReplayResultName

The first resource name to compare, or null.

bReplayResultName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.