Interface AccessApprovalSettingsOrBuilder (2.56.0) 

public interface AccessApprovalSettingsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getActiveKeyVersion()

public abstract String getActiveKeyVersion()

The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set.

string active_key_version = 6;

Returns
Type Description
String

The activeKeyVersion.

getActiveKeyVersionBytes()

public abstract ByteString getActiveKeyVersionBytes()

The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set.

string active_key_version = 6;

Returns
Type Description
ByteString

The bytes for activeKeyVersion.

getAncestorHasActiveKeyVersion()

public abstract boolean getAncestorHasActiveKeyVersion()

Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors).

bool ancestor_has_active_key_version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The ancestorHasActiveKeyVersion.

getEnrolledAncestor()

public abstract boolean getEnrolledAncestor()

Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors).

bool enrolled_ancestor = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The enrolledAncestor.

getEnrolledServices(int index)

public abstract EnrolledService getEnrolledServices(int index)

A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis.

If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded.

repeated .google.cloud.accessapproval.v1.EnrolledService enrolled_services = 3;

Parameter
Name Description
index int
Returns
Type Description
EnrolledService

getEnrolledServicesCount()

public abstract int getEnrolledServicesCount()

A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis.

If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded.

repeated .google.cloud.accessapproval.v1.EnrolledService enrolled_services = 3;

Returns
Type Description
int

getEnrolledServicesList()

public abstract List<EnrolledService> getEnrolledServicesList()

A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis.

If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded.

repeated .google.cloud.accessapproval.v1.EnrolledService enrolled_services = 3;

Returns
Type Description
List<EnrolledService>

getEnrolledServicesOrBuilder(int index)

public abstract EnrolledServiceOrBuilder getEnrolledServicesOrBuilder(int index)

A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis.

If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded.

repeated .google.cloud.accessapproval.v1.EnrolledService enrolled_services = 3;

Parameter
Name Description
index int
Returns
Type Description
EnrolledServiceOrBuilder

getEnrolledServicesOrBuilderList()

public abstract List<? extends EnrolledServiceOrBuilder> getEnrolledServicesOrBuilderList()

A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis.

If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded.

repeated .google.cloud.accessapproval.v1.EnrolledService enrolled_services = 3;

Returns
Type Description
List<? extends com.google.cloud.accessapproval.v1.EnrolledServiceOrBuilder>

getInvalidKeyVersion()

public abstract boolean getInvalidKeyVersion()

Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that there is some configuration issue with the active_key_version configured at this level in the resource hierarchy (e.g. it doesn't exist or the Access Approval service account doesn't have the correct permissions on it, etc.) This key version is not necessarily the effective key version at this level, as key versions are inherited top-down.

bool invalid_key_version = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The invalidKeyVersion.

getName()

public abstract String getName()

The resource name of the settings. Format is one of:

  • "projects/{project}/accessApprovalSettings"
  • "folders/{folder}/accessApprovalSettings"
  • "organizations/{organization}/accessApprovalSettings"

string name = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

The resource name of the settings. Format is one of:

  • "projects/{project}/accessApprovalSettings"
  • "folders/{folder}/accessApprovalSettings"
  • "organizations/{organization}/accessApprovalSettings"

string name = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getNotificationEmails(int index)

public abstract String getNotificationEmails(int index)

A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed.

repeated string notification_emails = 2;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The notificationEmails at the given index.

getNotificationEmailsBytes(int index)

public abstract ByteString getNotificationEmailsBytes(int index)

A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed.

repeated string notification_emails = 2;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the notificationEmails at the given index.

getNotificationEmailsCount()

public abstract int getNotificationEmailsCount()

A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed.

repeated string notification_emails = 2;

Returns
Type Description
int

The count of notificationEmails.

getNotificationEmailsList()

public abstract List<String> getNotificationEmailsList()

A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed.

repeated string notification_emails = 2;

Returns
Type Description
List<String>

A list containing the notificationEmails.