Package com.google.cloud.accessapproval.v1

Interface AccessApprovalSettingsOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    AccessApprovalSettings, AccessApprovalSettings.Builder
    public interface AccessApprovalSettingsOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        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:
        The name.

      • getNameBytes

        com.google.protobuf.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:
        The bytes for name.

      • getNotificationEmailsList

        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:
        A list containing the notificationEmails.

      • getNotificationEmailsCount

        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:
        The count of notificationEmails.

      • getNotificationEmails

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The notificationEmails at the given index.

      • getNotificationEmailsBytes

        com.google.protobuf.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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the notificationEmails at the given index.

      • getEnrolledServicesList

        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;

      • getEnrolledServices

        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;

      • getEnrolledServicesCount

        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;

      • getEnrolledServicesOrBuilderList

        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;

      • getEnrolledServicesOrBuilder

        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;

      • getEnrolledAncestor

        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:
        The enrolledAncestor.

      • getActiveKeyVersion

        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:
        The activeKeyVersion.

      • getActiveKeyVersionBytes

        com.google.protobuf.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:
        The bytes for activeKeyVersion.

      • getAncestorHasActiveKeyVersion

        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:
        The ancestorHasActiveKeyVersion.

      • getInvalidKeyVersion

        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:
        The invalidKeyVersion.