Chronicle v1 API - Class DataAccessScopeName (1.0.0-beta01) 

public sealed class DataAccessScopeName : IResourceName, IEquatable<DataAccessScopeName>

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

Resource name for the DataAccessScope resource.

Inheritance

object > DataAccessScopeName

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

DataAccessScopeName(string, string, string, string)

public DataAccessScopeName(string projectId, string locationId, string instanceId, string dataAccessScopeId)

Constructs a new instance of a DataAccessScopeName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}

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

The DataAccessScope ID. Must not be null or empty.

Properties

DataAccessScopeId

public string DataAccessScopeId { get; }

The DataAccessScope 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 DataAccessScopeName.ResourceNameType Type { get; }

The DataAccessScopeName.ResourceNameType of the contained resource name.

Property Value
Type Description
DataAccessScopeNameResourceNameType

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

Formats the IDs into the string representation of this DataAccessScopeName with pattern projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}.

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

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

The string representation of this DataAccessScopeName with pattern projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}.

FormatProjectLocationInstanceDataAccessScope(string, string, string, string)

public static string FormatProjectLocationInstanceDataAccessScope(string projectId, string locationId, string instanceId, string dataAccessScopeId)

Formats the IDs into the string representation of this DataAccessScopeName with pattern projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}.

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

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

The string representation of this DataAccessScopeName with pattern projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}.

FromProjectLocationInstanceDataAccessScope(string, string, string, string)

public static DataAccessScopeName FromProjectLocationInstanceDataAccessScope(string projectId, string locationId, string instanceId, string dataAccessScopeId)

Creates a DataAccessScopeName with the pattern projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}.

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

The DataAccessScope ID. Must not be null or empty.
Returns
Type Description
DataAccessScopeName

A new instance of DataAccessScopeName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DataAccessScopeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DataAccessScopeName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of DataAccessScopeName 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 DataAccessScopeName Parse(string dataAccessScopeName)

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

Parameter
Name Description
dataAccessScopeName string

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

The parsed DataAccessScopeName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}

Parse(string, bool)

public static DataAccessScopeName Parse(string dataAccessScopeName, bool allowUnparsed)

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

Parameters
Name Description
dataAccessScopeName 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
DataAccessScopeName

The parsed DataAccessScopeName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}
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 DataAccessScopeName)

public static bool TryParse(string dataAccessScopeName, out DataAccessScopeName result)

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

Parameters
Name Description
dataAccessScopeName string

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

When this method returns, the parsed DataAccessScopeName, 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}/dataAccessScopes/{data_access_scope}

TryParse(string, bool, out DataAccessScopeName)

public static bool TryParse(string dataAccessScopeName, bool allowUnparsed, out DataAccessScopeName result)

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

Parameters
Name Description
dataAccessScopeName 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 DataAccessScopeName

When this method returns, the parsed DataAccessScopeName, 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}/dataAccessScopes/{data_access_scope}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(DataAccessScopeName, DataAccessScopeName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DataAccessScopeName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DataAccessScopeName

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

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.