Security Command Center v2 API - Class ExternalSystemName (1.0.0)

public sealed class ExternalSystemName : IResourceName, IEquatable<ExternalSystemName>

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

Resource name for the ExternalSystem resource.

Inheritance

object > ExternalSystemName

Implements

IResourceName, IEquatable ExternalSystemName

Inherited Members

object.GetType()

Namespace

Google.Cloud.SecurityCenter.V2

Assembly

Google.Cloud.SecurityCenter.V2.dll

Constructors

ExternalSystemName(string, string, string, string)

public ExternalSystemName(string organizationId, string sourceId, string findingId, string externalsystemId)

Constructs a new instance of a ExternalSystemName class from the component parts of pattern organizations/{organization}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}

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.
`externalsystemId`	`string` The `Externalsystem` ID. Must not be `null` or empty.

Properties

ExternalsystemId

public string ExternalsystemId { get; }

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

The ExternalSystemName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ExternalSystemNameResourceNameType`

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 organizationId, string sourceId, string findingId, string externalsystemId)

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

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.
`externalsystemId`	`string` The `Externalsystem` ID. Must not be `null` or empty.

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

FormatFolderSourceFindingExternalsystem(string, string, string, string)

public static string FormatFolderSourceFindingExternalsystem(string folderId, string sourceId, string findingId, string externalsystemId)

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

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.
`externalsystemId`	`string` The `Externalsystem` ID. Must not be `null` or empty.

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

FormatFolderSourceLocationFindingExternalsystem(string, string, string, string, string)

public static string FormatFolderSourceLocationFindingExternalsystem(string folderId, string sourceId, string locationId, string findingId, string externalsystemId)

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

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.
`externalsystemId`	`string` The `Externalsystem` ID. Must not be `null` or empty.

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

FormatOrganizationSourceFindingExternalsystem(string, string, string, string)

public static string FormatOrganizationSourceFindingExternalsystem(string organizationId, string sourceId, string findingId, string externalsystemId)

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

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.
`externalsystemId`	`string` The `Externalsystem` ID. Must not be `null` or empty.

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

FormatOrganizationSourceLocationFindingExternalsystem(string, string, string, string, string)

public static string FormatOrganizationSourceLocationFindingExternalsystem(string organizationId, string sourceId, string locationId, string findingId, string externalsystemId)

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

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.
`externalsystemId`	`string` The `Externalsystem` ID. Must not be `null` or empty.

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

FormatProjectSourceFindingExternalsystem(string, string, string, string)

public static string FormatProjectSourceFindingExternalsystem(string projectId, string sourceId, string findingId, string externalsystemId)

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

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.
`externalsystemId`	`string` The `Externalsystem` ID. Must not be `null` or empty.

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

FormatProjectSourceLocationFindingExternalsystem(string, string, string, string, string)

public static string FormatProjectSourceLocationFindingExternalsystem(string projectId, string sourceId, string locationId, string findingId, string externalsystemId)

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

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.
`externalsystemId`	`string` The `Externalsystem` ID. Must not be `null` or empty.

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

FromFolderSourceFindingExternalsystem(string, string, string, string)

public static ExternalSystemName FromFolderSourceFindingExternalsystem(string folderId, string sourceId, string findingId, string externalsystemId)

Creates a ExternalSystemName with the pattern folders/{folder}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}.

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.
`externalsystemId`	`string` The `Externalsystem` ID. Must not be `null` or empty.

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

FromFolderSourceLocationFindingExternalsystem(string, string, string, string, string)

public static ExternalSystemName FromFolderSourceLocationFindingExternalsystem(string folderId, string sourceId, string locationId, string findingId, string externalsystemId)

Creates a ExternalSystemName with the pattern folders/{folder}/sources/{source}/locations/{location}/findings/{finding}/externalSystems/{externalsystem} .

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.
`externalsystemId`	`string` The `Externalsystem` ID. Must not be `null` or empty.

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

FromOrganizationSourceFindingExternalsystem(string, string, string, string)

public static ExternalSystemName FromOrganizationSourceFindingExternalsystem(string organizationId, string sourceId, string findingId, string externalsystemId)

Creates a ExternalSystemName with the pattern organizations/{organization}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}.

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.
`externalsystemId`	`string` The `Externalsystem` ID. Must not be `null` or empty.

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

FromOrganizationSourceLocationFindingExternalsystem(string, string, string, string, string)

public static ExternalSystemName FromOrganizationSourceLocationFindingExternalsystem(string organizationId, string sourceId, string locationId, string findingId, string externalsystemId)

Creates a ExternalSystemName with the pattern organizations/{organization}/sources/{source}/locations/{location}/findings/{finding}/externalSystems/{externalsystem} .

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.
`externalsystemId`	`string` The `Externalsystem` ID. Must not be `null` or empty.

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

FromProjectSourceFindingExternalsystem(string, string, string, string)

public static ExternalSystemName FromProjectSourceFindingExternalsystem(string projectId, string sourceId, string findingId, string externalsystemId)

Creates a ExternalSystemName with the pattern projects/{project}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}.

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.
`externalsystemId`	`string` The `Externalsystem` ID. Must not be `null` or empty.

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

FromProjectSourceLocationFindingExternalsystem(string, string, string, string, string)

public static ExternalSystemName FromProjectSourceLocationFindingExternalsystem(string projectId, string sourceId, string locationId, string findingId, string externalsystemId)

Creates a ExternalSystemName with the pattern projects/{project}/sources/{source}/locations/{location}/findings/{finding}/externalSystems/{externalsystem} .

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.
`externalsystemId`	`string` The `Externalsystem` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static ExternalSystemName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ExternalSystemName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

organizations/{organization}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}
organizations/{organization}/sources/{source}/locations/{location}/findings/{finding}/externalSystems/{externalsystem}
folders/{folder}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}
folders/{folder}/sources/{source}/locations/{location}/findings/{finding}/externalSystems/{externalsystem}
projects/{project}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}
projects/{project}/sources/{source}/locations/{location}/findings/{finding}/externalSystems/{externalsystem}

Parse(string, bool)

public static ExternalSystemName Parse(string externalSystemName, bool allowUnparsed)

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

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

Remarks

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

organizations/{organization}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}
organizations/{organization}/sources/{source}/locations/{location}/findings/{finding}/externalSystems/{externalsystem}
folders/{folder}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}
folders/{folder}/sources/{source}/locations/{location}/findings/{finding}/externalSystems/{externalsystem}
projects/{project}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}
projects/{project}/sources/{source}/locations/{location}/findings/{finding}/externalSystems/{externalsystem}

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

public static bool TryParse(string externalSystemName, out ExternalSystemName result)

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

Parameters
Name	Description
`externalSystemName`	`string` The resource name in string form. Must not be `null`.
`result`	`ExternalSystemName` When this method returns, the parsed ExternalSystemName, 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}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}
organizations/{organization}/sources/{source}/locations/{location}/findings/{finding}/externalSystems/{externalsystem}
folders/{folder}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}
folders/{folder}/sources/{source}/locations/{location}/findings/{finding}/externalSystems/{externalsystem}
projects/{project}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}
projects/{project}/sources/{source}/locations/{location}/findings/{finding}/externalSystems/{externalsystem}

TryParse(string, bool, out ExternalSystemName)

public static bool TryParse(string externalSystemName, bool allowUnparsed, out ExternalSystemName result)

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

Parameters
Name	Description
`externalSystemName`	`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`	`ExternalSystemName` When this method returns, the parsed ExternalSystemName, 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}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}
organizations/{organization}/sources/{source}/locations/{location}/findings/{finding}/externalSystems/{externalsystem}
folders/{folder}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}
folders/{folder}/sources/{source}/locations/{location}/findings/{finding}/externalSystems/{externalsystem}
projects/{project}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}
projects/{project}/sources/{source}/locations/{location}/findings/{finding}/externalSystems/{externalsystem}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ExternalSystemName, ExternalSystemName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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