Security Command Center v2 API - Class SecurityMarksName (1.0.0-beta05)

public sealed class SecurityMarksName : IResourceName, IEquatable<SecurityMarksName>

Reference documentation and code samples for the Security Command Center v2 API class SecurityMarksName.

Resource name for the SecurityMarks resource.

Inheritance

object > SecurityMarksName

Implements

IResourceName, IEquatable SecurityMarksName

Inherited Members

object.GetType()

Namespace

Google.Cloud.SecurityCenter.V2

Assembly

Google.Cloud.SecurityCenter.V2.dll

Constructors

SecurityMarksName(string, string)

public SecurityMarksName(string organizationId, string assetId)

Constructs a new instance of a SecurityMarksName class from the component parts of pattern organizations/{organization}/assets/{asset}/securityMarks

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`assetId`	`string` The `Asset` ID. Must not be `null` or empty.

Properties

AssetId

public string AssetId { get; }

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

Property Value
Type	Description
`string`

FindingId

public string FindingId { get; }

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

Property Value
Type	Description
`string`

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`

SourceId

public string SourceId { get; }

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

Property Value
Type	Description
`string`

Type

public SecurityMarksName.ResourceNameType Type { get; }

The SecurityMarksName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`SecurityMarksNameResourceNameType`

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)

public static string Format(string organizationId, string assetId)

Formats the IDs into the string representation of this SecurityMarksName with pattern organizations/{organization}/assets/{asset}/securityMarks.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`assetId`	`string` The `Asset` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SecurityMarksName with pattern `organizations/{organization}/assets/{asset}/securityMarks`.

FormatFolderAsset(string, string)

public static string FormatFolderAsset(string folderId, string assetId)

Formats the IDs into the string representation of this SecurityMarksName with pattern folders/{folder}/assets/{asset}/securityMarks.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`assetId`	`string` The `Asset` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SecurityMarksName with pattern `folders/{folder}/assets/{asset}/securityMarks`.

FormatFolderSourceFinding(string, string, string)

public static string FormatFolderSourceFinding(string folderId, string sourceId, string findingId)

Formats the IDs into the string representation of this SecurityMarksName with pattern folders/{folder}/sources/{source}/findings/{finding}/securityMarks.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`sourceId`	`string` The `Source` ID. Must not be `null` or empty.
`findingId`	`string` The `Finding` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SecurityMarksName with pattern `folders/{folder}/sources/{source}/findings/{finding}/securityMarks`.

FormatFolderSourceLocationFinding(string, string, string, string)

public static string FormatFolderSourceLocationFinding(string folderId, string sourceId, string locationId, string findingId)

Formats the IDs into the string representation of this SecurityMarksName with pattern folders/{folder}/sources/{source}/locations/{location}/findings/{finding}/securityMarks.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`sourceId`	`string` The `Source` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`findingId`	`string` The `Finding` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SecurityMarksName with pattern `folders/{folder}/sources/{source}/locations/{location}/findings/{finding}/securityMarks`.

FormatOrganizationAsset(string, string)

public static string FormatOrganizationAsset(string organizationId, string assetId)

Formats the IDs into the string representation of this SecurityMarksName with pattern organizations/{organization}/assets/{asset}/securityMarks.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`assetId`	`string` The `Asset` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SecurityMarksName with pattern `organizations/{organization}/assets/{asset}/securityMarks`.

FormatOrganizationSourceFinding(string, string, string)

public static string FormatOrganizationSourceFinding(string organizationId, string sourceId, string findingId)

Formats the IDs into the string representation of this SecurityMarksName with pattern organizations/{organization}/sources/{source}/findings/{finding}/securityMarks.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`sourceId`	`string` The `Source` ID. Must not be `null` or empty.
`findingId`	`string` The `Finding` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SecurityMarksName with pattern `organizations/{organization}/sources/{source}/findings/{finding}/securityMarks`.

FormatOrganizationSourceLocationFinding(string, string, string, string)

public static string FormatOrganizationSourceLocationFinding(string organizationId, string sourceId, string locationId, string findingId)

Formats the IDs into the string representation of this SecurityMarksName with pattern organizations/{organization}/sources/{source}/locations/{location}/findings/{finding}/securityMarks.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`sourceId`	`string` The `Source` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`findingId`	`string` The `Finding` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SecurityMarksName with pattern `organizations/{organization}/sources/{source}/locations/{location}/findings/{finding}/securityMarks`.

FormatProjectAsset(string, string)

public static string FormatProjectAsset(string projectId, string assetId)

Formats the IDs into the string representation of this SecurityMarksName with pattern projects/{project}/assets/{asset}/securityMarks.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`assetId`	`string` The `Asset` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SecurityMarksName with pattern `projects/{project}/assets/{asset}/securityMarks`.

FormatProjectSourceFinding(string, string, string)

public static string FormatProjectSourceFinding(string projectId, string sourceId, string findingId)

Formats the IDs into the string representation of this SecurityMarksName with pattern projects/{project}/sources/{source}/findings/{finding}/securityMarks.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`sourceId`	`string` The `Source` ID. Must not be `null` or empty.
`findingId`	`string` The `Finding` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SecurityMarksName with pattern `projects/{project}/sources/{source}/findings/{finding}/securityMarks`.

FormatProjectSourceLocationFinding(string, string, string, string)

public static string FormatProjectSourceLocationFinding(string projectId, string sourceId, string locationId, string findingId)

Formats the IDs into the string representation of this SecurityMarksName with pattern projects/{project}/sources/{source}/locations/{location}/findings/{finding}/securityMarks.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`sourceId`	`string` The `Source` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`findingId`	`string` The `Finding` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SecurityMarksName with pattern `projects/{project}/sources/{source}/locations/{location}/findings/{finding}/securityMarks`.

FromFolderAsset(string, string)

public static SecurityMarksName FromFolderAsset(string folderId, string assetId)

Creates a SecurityMarksName with the pattern folders/{folder}/assets/{asset}/securityMarks .

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`assetId`	`string` The `Asset` ID. Must not be `null` or empty.

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

FromFolderSourceFinding(string, string, string)

public static SecurityMarksName FromFolderSourceFinding(string folderId, string sourceId, string findingId)

Creates a SecurityMarksName with the pattern folders/{folder}/sources/{source}/findings/{finding}/securityMarks.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`sourceId`	`string` The `Source` ID. Must not be `null` or empty.
`findingId`	`string` The `Finding` ID. Must not be `null` or empty.

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

FromFolderSourceLocationFinding(string, string, string, string)

public static SecurityMarksName FromFolderSourceLocationFinding(string folderId, string sourceId, string locationId, string findingId)

Creates a SecurityMarksName with the pattern folders/{folder}/sources/{source}/locations/{location}/findings/{finding}/securityMarks.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`sourceId`	`string` The `Source` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`findingId`	`string` The `Finding` ID. Must not be `null` or empty.

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

FromOrganizationAsset(string, string)

public static SecurityMarksName FromOrganizationAsset(string organizationId, string assetId)

Creates a SecurityMarksName with the pattern organizations/{organization}/assets/{asset}/securityMarks.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`assetId`	`string` The `Asset` ID. Must not be `null` or empty.

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

FromOrganizationSourceFinding(string, string, string)

public static SecurityMarksName FromOrganizationSourceFinding(string organizationId, string sourceId, string findingId)

Creates a SecurityMarksName with the pattern organizations/{organization}/sources/{source}/findings/{finding}/securityMarks.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`sourceId`	`string` The `Source` ID. Must not be `null` or empty.
`findingId`	`string` The `Finding` ID. Must not be `null` or empty.

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

FromOrganizationSourceLocationFinding(string, string, string, string)

public static SecurityMarksName FromOrganizationSourceLocationFinding(string organizationId, string sourceId, string locationId, string findingId)

Creates a SecurityMarksName with the pattern organizations/{organization}/sources/{source}/locations/{location}/findings/{finding}/securityMarks.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`sourceId`	`string` The `Source` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`findingId`	`string` The `Finding` ID. Must not be `null` or empty.

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

FromProjectAsset(string, string)

public static SecurityMarksName FromProjectAsset(string projectId, string assetId)

Creates a SecurityMarksName with the pattern projects/{project}/assets/{asset}/securityMarks.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`assetId`	`string` The `Asset` ID. Must not be `null` or empty.

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

FromProjectSourceFinding(string, string, string)

public static SecurityMarksName FromProjectSourceFinding(string projectId, string sourceId, string findingId)

Creates a SecurityMarksName with the pattern projects/{project}/sources/{source}/findings/{finding}/securityMarks.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`sourceId`	`string` The `Source` ID. Must not be `null` or empty.
`findingId`	`string` The `Finding` ID. Must not be `null` or empty.

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

FromProjectSourceLocationFinding(string, string, string, string)

public static SecurityMarksName FromProjectSourceLocationFinding(string projectId, string sourceId, string locationId, string findingId)

Creates a SecurityMarksName with the pattern projects/{project}/sources/{source}/locations/{location}/findings/{finding}/securityMarks.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`sourceId`	`string` The `Source` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`findingId`	`string` The `Finding` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static SecurityMarksName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SecurityMarksName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

organizations/{organization}/assets/{asset}/securityMarks
organizations/{organization}/sources/{source}/findings/{finding}/securityMarks
organizations/{organization}/sources/{source}/locations/{location}/findings/{finding}/securityMarks
folders/{folder}/assets/{asset}/securityMarks
folders/{folder}/sources/{source}/findings/{finding}/securityMarks
folders/{folder}/sources/{source}/locations/{location}/findings/{finding}/securityMarks
projects/{project}/assets/{asset}/securityMarks
projects/{project}/sources/{source}/findings/{finding}/securityMarks
projects/{project}/sources/{source}/locations/{location}/findings/{finding}/securityMarks

Parse(string, bool)

public static SecurityMarksName Parse(string securityMarksName, bool allowUnparsed)

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

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

Remarks

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

organizations/{organization}/assets/{asset}/securityMarks
organizations/{organization}/sources/{source}/findings/{finding}/securityMarks
organizations/{organization}/sources/{source}/locations/{location}/findings/{finding}/securityMarks
folders/{folder}/assets/{asset}/securityMarks
folders/{folder}/sources/{source}/findings/{finding}/securityMarks
folders/{folder}/sources/{source}/locations/{location}/findings/{finding}/securityMarks
projects/{project}/assets/{asset}/securityMarks
projects/{project}/sources/{source}/findings/{finding}/securityMarks
projects/{project}/sources/{source}/locations/{location}/findings/{finding}/securityMarks

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

public static bool TryParse(string securityMarksName, out SecurityMarksName result)

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

Parameters
Name	Description
`securityMarksName`	`string` The resource name in string form. Must not be `null`.
`result`	`SecurityMarksName` When this method returns, the parsed SecurityMarksName, 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:

organizations/{organization}/assets/{asset}/securityMarks
organizations/{organization}/sources/{source}/findings/{finding}/securityMarks
organizations/{organization}/sources/{source}/locations/{location}/findings/{finding}/securityMarks
folders/{folder}/assets/{asset}/securityMarks
folders/{folder}/sources/{source}/findings/{finding}/securityMarks
folders/{folder}/sources/{source}/locations/{location}/findings/{finding}/securityMarks
projects/{project}/assets/{asset}/securityMarks
projects/{project}/sources/{source}/findings/{finding}/securityMarks
projects/{project}/sources/{source}/locations/{location}/findings/{finding}/securityMarks

TryParse(string, bool, out SecurityMarksName)

public static bool TryParse(string securityMarksName, bool allowUnparsed, out SecurityMarksName result)

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

Parameters
Name	Description
`securityMarksName`	`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`	`SecurityMarksName` When this method returns, the parsed SecurityMarksName, 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:

organizations/{organization}/assets/{asset}/securityMarks
organizations/{organization}/sources/{source}/findings/{finding}/securityMarks
organizations/{organization}/sources/{source}/locations/{location}/findings/{finding}/securityMarks
folders/{folder}/assets/{asset}/securityMarks
folders/{folder}/sources/{source}/findings/{finding}/securityMarks
folders/{folder}/sources/{source}/locations/{location}/findings/{finding}/securityMarks
projects/{project}/assets/{asset}/securityMarks
projects/{project}/sources/{source}/findings/{finding}/securityMarks
projects/{project}/sources/{source}/locations/{location}/findings/{finding}/securityMarks

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SecurityMarksName, SecurityMarksName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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