public sealed class ReferenceListName : IResourceName, IEquatable<ReferenceListName>
Reference documentation and code samples for the Chronicle v1 API class ReferenceListName.
Resource name for the ReferenceList
resource.
Namespace
Google.Cloud.Chronicle.V1Assembly
Google.Cloud.Chronicle.V1.dll
Constructors
ReferenceListName(string, string, string, string)
public ReferenceListName(string projectId, string locationId, string instanceId, string referenceListId)
Constructs a new instance of a ReferenceListName class from the component parts of pattern
projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
instanceId |
string The |
referenceListId |
string The |
Properties
InstanceId
public string InstanceId { get; }
The Instance
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 |
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 |
ReferenceListId
public string ReferenceListId { get; }
The ReferenceList
ID. Will not be null
, unless this instance contains an unparsed resource
name.
Property Value | |
---|---|
Type | Description |
string |
Type
public ReferenceListName.ResourceNameType Type { get; }
The ReferenceListName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
ReferenceListNameResourceNameType |
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 instanceId, string referenceListId)
Formats the IDs into the string representation of this ReferenceListName with pattern
projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
instanceId |
string The |
referenceListId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this ReferenceListName with pattern
|
FormatProjectLocationInstanceReferenceList(string, string, string, string)
public static string FormatProjectLocationInstanceReferenceList(string projectId, string locationId, string instanceId, string referenceListId)
Formats the IDs into the string representation of this ReferenceListName with pattern
projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
instanceId |
string The |
referenceListId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this ReferenceListName with pattern
|
FromProjectLocationInstanceReferenceList(string, string, string, string)
public static ReferenceListName FromProjectLocationInstanceReferenceList(string projectId, string locationId, string instanceId, string referenceListId)
Creates a ReferenceListName with the pattern
projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
instanceId |
string The |
referenceListId |
string The |
Returns | |
---|---|
Type | Description |
ReferenceListName |
A new instance of ReferenceListName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static ReferenceListName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a ReferenceListName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName |
UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
ReferenceListName |
A new instance of ReferenceListName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static ReferenceListName Parse(string referenceListName)
Parses the given resource name string into a new ReferenceListName instance.
Parameter | |
---|---|
Name | Description |
referenceListName |
string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
ReferenceListName |
The parsed ReferenceListName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}
Parse(string, bool)
public static ReferenceListName Parse(string referenceListName, bool allowUnparsed)
Parses the given resource name string into a new ReferenceListName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
referenceListName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
Returns | |
---|---|
Type | Description |
ReferenceListName |
The parsed ReferenceListName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}
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. |
TryParse(string, out ReferenceListName)
public static bool TryParse(string referenceListName, out ReferenceListName result)
Tries to parse the given resource name string into a new ReferenceListName instance.
Parameters | |
---|---|
Name | Description |
referenceListName |
string The resource name in string form. Must not be |
result |
ReferenceListName When this method returns, the parsed ReferenceListName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}
TryParse(string, bool, out ReferenceListName)
public static bool TryParse(string referenceListName, bool allowUnparsed, out ReferenceListName result)
Tries to parse the given resource name string into a new ReferenceListName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
referenceListName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
result |
ReferenceListName When this method returns, the parsed ReferenceListName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}
allowUnparsed
is true
.
Operators
operator ==(ReferenceListName, ReferenceListName)
public static bool operator ==(ReferenceListName a, ReferenceListName b)
Determines whether two specified resource names have the same value.
Parameters | |
---|---|
Name | Description |
a |
ReferenceListName The first resource name to compare, or null. |
b |
ReferenceListName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |
operator !=(ReferenceListName, ReferenceListName)
public static bool operator !=(ReferenceListName a, ReferenceListName b)
Determines whether two specified resource names have different values.
Parameters | |
---|---|
Name | Description |
a |
ReferenceListName The first resource name to compare, or null. |
b |
ReferenceListName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |