Package com.google.cloud.accessapproval.v1

Class AccessApprovalSettings

  • All Implemented Interfaces:
    AccessApprovalSettingsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class AccessApprovalSettings
extends com.google.protobuf.GeneratedMessageV3
implements AccessApprovalSettingsOrBuilder
     Settings on a Project/Folder/Organization related to Access Approval.
    Protobuf type google.cloud.accessapproval.v1.AccessApprovalSettings
    See Also:
    Serialized Form

    • Field Detail

      • NOTIFICATION_EMAILS_FIELD_NUMBER

        public static final int NOTIFICATION_EMAILS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENROLLED_SERVICES_FIELD_NUMBER

        public static final int ENROLLED_SERVICES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENROLLED_ANCESTOR_FIELD_NUMBER

        public static final int ENROLLED_ANCESTOR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ACTIVE_KEY_VERSION_FIELD_NUMBER

        public static final int ACTIVE_KEY_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ANCESTOR_HAS_ACTIVE_KEY_VERSION_FIELD_NUMBER

        public static final int ANCESTOR_HAS_ACTIVE_KEY_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INVALID_KEY_VERSION_FIELD_NUMBER

        public static final int INVALID_KEY_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public 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) = { ... }
        Specified by:
        getName in interface AccessApprovalSettingsOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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) = { ... }
        Specified by:
        getNameBytes in interface AccessApprovalSettingsOrBuilder
        Returns:
        The bytes for name.

      • getNotificationEmailsList

        public com.google.protobuf.ProtocolStringList 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;
        Specified by:
        getNotificationEmailsList in interface AccessApprovalSettingsOrBuilder
        Returns:
        A list containing the notificationEmails.

      • getNotificationEmailsCount

        public 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;
        Specified by:
        getNotificationEmailsCount in interface AccessApprovalSettingsOrBuilder
        Returns:
        The count of notificationEmails.

      • getNotificationEmails

        public 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;
        Specified by:
        getNotificationEmails in interface AccessApprovalSettingsOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The notificationEmails at the given index.

      • getNotificationEmailsBytes

        public 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;
        Specified by:
        getNotificationEmailsBytes in interface AccessApprovalSettingsOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the notificationEmails at the given index.

      • getEnrolledServicesList

        public 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;
        Specified by:
        getEnrolledServicesList in interface AccessApprovalSettingsOrBuilder

      • getEnrolledServicesOrBuilderList

        public 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;
        Specified by:
        getEnrolledServicesOrBuilderList in interface AccessApprovalSettingsOrBuilder

      • getEnrolledServicesCount

        public 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;
        Specified by:
        getEnrolledServicesCount in interface AccessApprovalSettingsOrBuilder

      • getEnrolledServices

        public 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;
        Specified by:
        getEnrolledServices in interface AccessApprovalSettingsOrBuilder

      • getEnrolledServicesOrBuilder

        public 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;
        Specified by:
        getEnrolledServicesOrBuilder in interface AccessApprovalSettingsOrBuilder

      • getEnrolledAncestor

        public 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];
        Specified by:
        getEnrolledAncestor in interface AccessApprovalSettingsOrBuilder
        Returns:
        The enrolledAncestor.

      • getActiveKeyVersion

        public 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;
        Specified by:
        getActiveKeyVersion in interface AccessApprovalSettingsOrBuilder
        Returns:
        The activeKeyVersion.

      • getActiveKeyVersionBytes

        public 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;
        Specified by:
        getActiveKeyVersionBytes in interface AccessApprovalSettingsOrBuilder
        Returns:
        The bytes for activeKeyVersion.

      • getAncestorHasActiveKeyVersion

        public 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];
        Specified by:
        getAncestorHasActiveKeyVersion in interface AccessApprovalSettingsOrBuilder
        Returns:
        The ancestorHasActiveKeyVersion.

      • getInvalidKeyVersion

        public 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];
        Specified by:
        getInvalidKeyVersion in interface AccessApprovalSettingsOrBuilder
        Returns:
        The invalidKeyVersion.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static AccessApprovalSettings parseFrom​(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AccessApprovalSettings parseFrom​(ByteBuffer data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AccessApprovalSettings parseFrom​(com.google.protobuf.ByteString data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AccessApprovalSettings parseFrom​(com.google.protobuf.ByteString data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AccessApprovalSettings parseFrom​(byte[] data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AccessApprovalSettings parseFrom​(byte[] data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public AccessApprovalSettings.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public AccessApprovalSettings.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected AccessApprovalSettings.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<AccessApprovalSettings> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public AccessApprovalSettings getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder