Google Cloud Audit Manager V1 Client - Class ResourceEnrollmentStatus (0.4.1)

Reference documentation and code samples for the Google Cloud Audit Manager V1 Client class ResourceEnrollmentStatus.

An organization, folder, or project with its enrollment status.

Generated from protobuf message google.cloud.auditmanager.v1.ResourceEnrollmentStatus

Namespace

Google \ Cloud \ AuditManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Identifier. Name of the resource enrollment status, in one of the following formats: * * folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status} * * projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status} * * organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}
↳ enrollment Enrollment

Output only. Enrolled destination details for the organization, folder, or project.
↳ enrolled bool

Output only. Deprecated. Whether the organization, folder, or project is enrolled. Use enrollment_state instead.
↳ display_name string

Output only. Display name for the organization, folder, or project.
↳ enrollment_state int

Output only. Enrollment state of the organization, folder, or project.

getName

Identifier. Name of the resource enrollment status, in one of the following formats:

  • folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}
  • projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}
  • organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}
Returns
Type Description
string

setName

Identifier. Name of the resource enrollment status, in one of the following formats:

  • folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}
  • projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}
  • organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}
Parameter
Name Description
var string
Returns
Type Description
$this

getEnrollment

Output only. Enrolled destination details for the organization, folder, or project.

Returns
Type Description
Enrollment|null

hasEnrollment

clearEnrollment

setEnrollment

Output only. Enrolled destination details for the organization, folder, or project.

Parameter
Name Description
var Enrollment
Returns
Type Description
$this

getEnrolled

Output only. Deprecated. Whether the organization, folder, or project is enrolled. Use enrollment_state instead.

Returns
Type Description
bool

setEnrolled

Output only. Deprecated. Whether the organization, folder, or project is enrolled. Use enrollment_state instead.

Parameter
Name Description
var bool
Returns
Type Description
$this

getDisplayName

Output only. Display name for the organization, folder, or project.

Returns
Type Description
string

setDisplayName

Output only. Display name for the organization, folder, or project.

Parameter
Name Description
var string
Returns
Type Description
$this

getEnrollmentState

Output only. Enrollment state of the organization, folder, or project.

Returns
Type Description
int Enum of type ResourceEnrollmentState.

setEnrollmentState

Output only. Enrollment state of the organization, folder, or project.

Parameter
Name Description
var int

Enum of type ResourceEnrollmentState.

Returns
Type Description
$this