Chronicle v1 API - Class DataAccessLabelName (1.0.0-beta02) 

public sealed class DataAccessLabelName : IResourceName, IEquatable<DataAccessLabelName>

Reference documentation and code samples for the Chronicle v1 API class DataAccessLabelName.

Resource name for the DataAccessLabel resource.

Inheritance

object > DataAccessLabelName

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

DataAccessLabelName(string, string, string, string)

public DataAccessLabelName(string projectId, string locationId, string instanceId, string dataAccessLabelId)

Constructs a new instance of a DataAccessLabelName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}

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.
instanceId string

The Instance ID. Must not be null or empty.
dataAccessLabelId string

The DataAccessLabel ID. Must not be null or empty.

Properties

DataAccessLabelId

public string DataAccessLabelId { get; }

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

Property Value
Type Description
string

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

Type

public DataAccessLabelName.ResourceNameType Type { get; }

The DataAccessLabelName.ResourceNameType of the contained resource name.

Property Value
Type Description
DataAccessLabelNameResourceNameType

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

Formats the IDs into the string representation of this DataAccessLabelName with pattern projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}.

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.
instanceId string

The Instance ID. Must not be null or empty.
dataAccessLabelId string

The DataAccessLabel ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DataAccessLabelName with pattern projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}.

FormatProjectLocationInstanceDataAccessLabel(string, string, string, string)

public static string FormatProjectLocationInstanceDataAccessLabel(string projectId, string locationId, string instanceId, string dataAccessLabelId)

Formats the IDs into the string representation of this DataAccessLabelName with pattern projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}.

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.
instanceId string

The Instance ID. Must not be null or empty.
dataAccessLabelId string

The DataAccessLabel ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DataAccessLabelName with pattern projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}.

FromProjectLocationInstanceDataAccessLabel(string, string, string, string)

public static DataAccessLabelName FromProjectLocationInstanceDataAccessLabel(string projectId, string locationId, string instanceId, string dataAccessLabelId)

Creates a DataAccessLabelName with the pattern projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}.

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.
instanceId string

The Instance ID. Must not be null or empty.
dataAccessLabelId string

The DataAccessLabel ID. Must not be null or empty.
Returns
Type Description
DataAccessLabelName

A new instance of DataAccessLabelName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DataAccessLabelName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DataAccessLabelName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
DataAccessLabelName

A new instance of DataAccessLabelName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static DataAccessLabelName Parse(string dataAccessLabelName)

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

Parameter
Name Description
dataAccessLabelName string

The resource name in string form. Must not be null.
Returns
Type Description
DataAccessLabelName

The parsed DataAccessLabelName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}

Parse(string, bool)

public static DataAccessLabelName Parse(string dataAccessLabelName, bool allowUnparsed)

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

Parameters
Name Description
dataAccessLabelName 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
DataAccessLabelName

The parsed DataAccessLabelName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}
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

TryParse(string, out DataAccessLabelName)

public static bool TryParse(string dataAccessLabelName, out DataAccessLabelName result)

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

Parameters
Name Description
dataAccessLabelName string

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

When this method returns, the parsed DataAccessLabelName, 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}/instances/{instance}/dataAccessLabels/{data_access_label}

TryParse(string, bool, out DataAccessLabelName)

public static bool TryParse(string dataAccessLabelName, bool allowUnparsed, out DataAccessLabelName result)

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

Parameters
Name Description
dataAccessLabelName 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 DataAccessLabelName

When this method returns, the parsed DataAccessLabelName, 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}/instances/{instance}/dataAccessLabels/{data_access_label}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(DataAccessLabelName, DataAccessLabelName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DataAccessLabelName

The first resource name to compare, or null.
b DataAccessLabelName

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 !=(DataAccessLabelName, DataAccessLabelName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DataAccessLabelName

The first resource name to compare, or null.
b DataAccessLabelName

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.