Class Permission (3.31.0)

public final class Permission extends GeneratedMessageV3 implements PermissionOrBuilder

A permission which can be included by a role.

Protobuf type google.iam.admin.v1.Permission

Implements

PermissionOrBuilder

Static Fields

API_DISABLED_FIELD_NUMBER

public static final int API_DISABLED_FIELD_NUMBER
Field Value
TypeDescription
int

CUSTOM_ROLES_SUPPORT_LEVEL_FIELD_NUMBER

public static final int CUSTOM_ROLES_SUPPORT_LEVEL_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

ONLY_IN_PREDEFINED_ROLES_FIELD_NUMBER

public static final int ONLY_IN_PREDEFINED_ROLES_FIELD_NUMBER
Field Value
TypeDescription
int

PRIMARY_PERMISSION_FIELD_NUMBER

public static final int PRIMARY_PERMISSION_FIELD_NUMBER
Field Value
TypeDescription
int

STAGE_FIELD_NUMBER

public static final int STAGE_FIELD_NUMBER
Field Value
TypeDescription
int

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Permission getDefaultInstance()
Returns
TypeDescription
Permission

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Permission.Builder newBuilder()
Returns
TypeDescription
Permission.Builder

newBuilder(Permission prototype)

public static Permission.Builder newBuilder(Permission prototype)
Parameter
NameDescription
prototypePermission
Returns
TypeDescription
Permission.Builder

parseDelimitedFrom(InputStream input)

public static Permission parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Permission
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Permission parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Permission
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Permission parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Permission
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Permission parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Permission
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Permission parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Permission
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Permission parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Permission
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Permission parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Permission
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Permission parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Permission
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Permission parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Permission
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Permission parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Permission
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Permission parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Permission
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Permission parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Permission
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Permission> parser()
Returns
TypeDescription
Parser<Permission>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getApiDisabled()

public boolean getApiDisabled()

The service API associated with the permission is not enabled.

bool api_disabled = 7;

Returns
TypeDescription
boolean

The apiDisabled.

getCustomRolesSupportLevel()

public Permission.CustomRolesSupportLevel getCustomRolesSupportLevel()

The current custom role support level.

.google.iam.admin.v1.Permission.CustomRolesSupportLevel custom_roles_support_level = 6;

Returns
TypeDescription
Permission.CustomRolesSupportLevel

The customRolesSupportLevel.

getCustomRolesSupportLevelValue()

public int getCustomRolesSupportLevelValue()

The current custom role support level.

.google.iam.admin.v1.Permission.CustomRolesSupportLevel custom_roles_support_level = 6;

Returns
TypeDescription
int

The enum numeric value on the wire for customRolesSupportLevel.

getDefaultInstanceForType()

public Permission getDefaultInstanceForType()
Returns
TypeDescription
Permission

getDescription()

public String getDescription()

A brief description of what this Permission is used for. This permission can ONLY be used in predefined roles.

string description = 3;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

A brief description of what this Permission is used for. This permission can ONLY be used in predefined roles.

string description = 3;

Returns
TypeDescription
ByteString

The bytes for description.

getName()

public String getName()

The name of this Permission.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of this Permission.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getOnlyInPredefinedRoles() (deprecated)

public boolean getOnlyInPredefinedRoles()

Deprecated. google.iam.admin.v1.Permission.only_in_predefined_roles is deprecated. See google/iam/admin/v1/iam.proto;l=1450

bool only_in_predefined_roles = 4 [deprecated = true];

Returns
TypeDescription
boolean

The onlyInPredefinedRoles.

getParserForType()

public Parser<Permission> getParserForType()
Returns
TypeDescription
Parser<Permission>
Overrides

getPrimaryPermission()

public String getPrimaryPermission()

The preferred name for this permission. If present, then this permission is an alias of, and equivalent to, the listed primary_permission.

string primary_permission = 8;

Returns
TypeDescription
String

The primaryPermission.

getPrimaryPermissionBytes()

public ByteString getPrimaryPermissionBytes()

The preferred name for this permission. If present, then this permission is an alias of, and equivalent to, the listed primary_permission.

string primary_permission = 8;

Returns
TypeDescription
ByteString

The bytes for primaryPermission.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStage()

public Permission.PermissionLaunchStage getStage()

The current launch stage of the permission.

.google.iam.admin.v1.Permission.PermissionLaunchStage stage = 5;

Returns
TypeDescription
Permission.PermissionLaunchStage

The stage.

getStageValue()

public int getStageValue()

The current launch stage of the permission.

.google.iam.admin.v1.Permission.PermissionLaunchStage stage = 5;

Returns
TypeDescription
int

The enum numeric value on the wire for stage.

getTitle()

public String getTitle()

The title of this Permission.

string title = 2;

Returns
TypeDescription
String

The title.

getTitleBytes()

public ByteString getTitleBytes()

The title of this Permission.

string title = 2;

Returns
TypeDescription
ByteString

The bytes for title.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Permission.Builder newBuilderForType()
Returns
TypeDescription
Permission.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Permission.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Permission.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Permission.Builder toBuilder()
Returns
TypeDescription
Permission.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException