public final class AccessApprovalSettings extends GeneratedMessageV3 implements AccessApprovalSettingsOrBuilder
Settings on a Project/Folder/Organization related to Access Approval.
Protobuf type google.cloud.accessapproval.v1.AccessApprovalSettings
Static Fields
ACTIVE_KEY_VERSION_FIELD_NUMBER
public static final int ACTIVE_KEY_VERSION_FIELD_NUMBER
Field Value
ANCESTOR_HAS_ACTIVE_KEY_VERSION_FIELD_NUMBER
public static final int ANCESTOR_HAS_ACTIVE_KEY_VERSION_FIELD_NUMBER
Field Value
ENROLLED_ANCESTOR_FIELD_NUMBER
public static final int ENROLLED_ANCESTOR_FIELD_NUMBER
Field Value
ENROLLED_SERVICES_FIELD_NUMBER
public static final int ENROLLED_SERVICES_FIELD_NUMBER
Field Value
INVALID_KEY_VERSION_FIELD_NUMBER
public static final int INVALID_KEY_VERSION_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
NOTIFICATION_EMAILS_FIELD_NUMBER
public static final int NOTIFICATION_EMAILS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static AccessApprovalSettings getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static AccessApprovalSettings.Builder newBuilder()
Returns
newBuilder(AccessApprovalSettings prototype)
public static AccessApprovalSettings.Builder newBuilder(AccessApprovalSettings prototype)
Parameter
Returns
public static AccessApprovalSettings parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static AccessApprovalSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static AccessApprovalSettings parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AccessApprovalSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static AccessApprovalSettings parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AccessApprovalSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AccessApprovalSettings parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static AccessApprovalSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AccessApprovalSettings parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static AccessApprovalSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static AccessApprovalSettings parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AccessApprovalSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<AccessApprovalSettings> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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;
| Type | Description |
| String | The activeKeyVersion.
|
getActiveKeyVersionBytes()
public 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;
| Type | Description |
| ByteString | 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];
| Type | Description |
| boolean | The ancestorHasActiveKeyVersion.
|
getDefaultInstanceForType()
public AccessApprovalSettings getDefaultInstanceForType()
Returns
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];
| Type | Description |
| boolean | The enrolledAncestor.
|
getEnrolledServices(int index)
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;
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;
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;
getEnrolledServicesOrBuilder(int index)
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;
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;
| Type | Description |
| List<? extends com.google.cloud.accessapproval.v1.EnrolledServiceOrBuilder> | |
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];
| Type | Description |
| boolean | The invalidKeyVersion.
|
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) = { ... }
| Type | Description |
| String | The name.
|
getNameBytes()
public 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) = { ... }
getNotificationEmails(int index)
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;
| 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 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;
| 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 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;
| Type | Description |
| int | The count of notificationEmails.
|
getNotificationEmailsList()
public 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;
getParserForType()
public Parser<AccessApprovalSettings> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public AccessApprovalSettings.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AccessApprovalSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public AccessApprovalSettings.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
