Class Permission.Builder (3.38.0)

public static final class Permission.Builder extends GeneratedMessageV3.Builder<Permission.Builder> implements PermissionOrBuilder

A permission which can be included by a role.

Protobuf type google.iam.admin.v1.Permission

Implements

PermissionOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Permission.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Permission.Builder
Overrides

build()

public Permission build()
Returns
Type Description
Permission

buildPartial()

public Permission buildPartial()
Returns
Type Description
Permission

clear()

public Permission.Builder clear()
Returns
Type Description
Permission.Builder
Overrides

clearApiDisabled()

public Permission.Builder clearApiDisabled()

The service API associated with the permission is not enabled.

bool api_disabled = 7;

Returns
Type Description
Permission.Builder

This builder for chaining.

clearCustomRolesSupportLevel()

public Permission.Builder clearCustomRolesSupportLevel()

The current custom role support level.

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

Returns
Type Description
Permission.Builder

This builder for chaining.

clearDescription()

public Permission.Builder clearDescription()

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

string description = 3;

Returns
Type Description
Permission.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Permission.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Permission.Builder
Overrides

clearName()

public Permission.Builder clearName()

The name of this Permission.

string name = 1;

Returns
Type Description
Permission.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Permission.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Permission.Builder
Overrides

clearOnlyInPredefinedRoles() (deprecated)

public Permission.Builder clearOnlyInPredefinedRoles()

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
Type Description
Permission.Builder

This builder for chaining.

clearPrimaryPermission()

public Permission.Builder clearPrimaryPermission()

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
Type Description
Permission.Builder

This builder for chaining.

clearStage()

public Permission.Builder clearStage()

The current launch stage of the permission.

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

Returns
Type Description
Permission.Builder

This builder for chaining.

clearTitle()

public Permission.Builder clearTitle()

The title of this Permission.

string title = 2;

Returns
Type Description
Permission.Builder

This builder for chaining.

clone()

public Permission.Builder clone()
Returns
Type Description
Permission.Builder
Overrides

getApiDisabled()

public boolean getApiDisabled()

The service API associated with the permission is not enabled.

bool api_disabled = 7;

Returns
Type Description
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
Type Description
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
Type Description
int

The enum numeric value on the wire for customRolesSupportLevel.

getDefaultInstanceForType()

public Permission getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getName()

public String getName()

The name of this Permission.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of this Permission.

string name = 1;

Returns
Type Description
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
Type Description
boolean

The onlyInPredefinedRoles.

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
Type Description
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
Type Description
ByteString

The bytes for primaryPermission.

getStage()

public Permission.PermissionLaunchStage getStage()

The current launch stage of the permission.

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

Returns
Type Description
Permission.PermissionLaunchStage

The stage.

getStageValue()

public int getStageValue()

The current launch stage of the permission.

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

Returns
Type Description
int

The enum numeric value on the wire for stage.

getTitle()

public String getTitle()

The title of this Permission.

string title = 2;

Returns
Type Description
String

The title.

getTitleBytes()

public ByteString getTitleBytes()

The title of this Permission.

string title = 2;

Returns
Type Description
ByteString

The bytes for title.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Permission other)

public Permission.Builder mergeFrom(Permission other)
Parameter
Name Description
other Permission
Returns
Type Description
Permission.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Permission.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Permission.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Permission.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Permission.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Permission.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Permission.Builder
Overrides

setApiDisabled(boolean value)

public Permission.Builder setApiDisabled(boolean value)

The service API associated with the permission is not enabled.

bool api_disabled = 7;

Parameter
Name Description
value boolean

The apiDisabled to set.

Returns
Type Description
Permission.Builder

This builder for chaining.

setCustomRolesSupportLevel(Permission.CustomRolesSupportLevel value)

public Permission.Builder setCustomRolesSupportLevel(Permission.CustomRolesSupportLevel value)

The current custom role support level.

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

Parameter
Name Description
value Permission.CustomRolesSupportLevel

The customRolesSupportLevel to set.

Returns
Type Description
Permission.Builder

This builder for chaining.

setCustomRolesSupportLevelValue(int value)

public Permission.Builder setCustomRolesSupportLevelValue(int value)

The current custom role support level.

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

Parameter
Name Description
value int

The enum numeric value on the wire for customRolesSupportLevel to set.

Returns
Type Description
Permission.Builder

This builder for chaining.

setDescription(String value)

public Permission.Builder setDescription(String value)

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

string description = 3;

Parameter
Name Description
value String

The description to set.

Returns
Type Description
Permission.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Permission.Builder setDescriptionBytes(ByteString value)

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

string description = 3;

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
Permission.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Permission.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Permission.Builder
Overrides

setName(String value)

public Permission.Builder setName(String value)

The name of this Permission.

string name = 1;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Permission.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Permission.Builder setNameBytes(ByteString value)

The name of this Permission.

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Permission.Builder

This builder for chaining.

setOnlyInPredefinedRoles(boolean value) (deprecated)

public Permission.Builder setOnlyInPredefinedRoles(boolean value)

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];

Parameter
Name Description
value boolean

The onlyInPredefinedRoles to set.

Returns
Type Description
Permission.Builder

This builder for chaining.

setPrimaryPermission(String value)

public Permission.Builder setPrimaryPermission(String value)

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;

Parameter
Name Description
value String

The primaryPermission to set.

Returns
Type Description
Permission.Builder

This builder for chaining.

setPrimaryPermissionBytes(ByteString value)

public Permission.Builder setPrimaryPermissionBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for primaryPermission to set.

Returns
Type Description
Permission.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Permission.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Permission.Builder
Overrides

setStage(Permission.PermissionLaunchStage value)

public Permission.Builder setStage(Permission.PermissionLaunchStage value)

The current launch stage of the permission.

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

Parameter
Name Description
value Permission.PermissionLaunchStage

The stage to set.

Returns
Type Description
Permission.Builder

This builder for chaining.

setStageValue(int value)

public Permission.Builder setStageValue(int value)

The current launch stage of the permission.

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

Parameter
Name Description
value int

The enum numeric value on the wire for stage to set.

Returns
Type Description
Permission.Builder

This builder for chaining.

setTitle(String value)

public Permission.Builder setTitle(String value)

The title of this Permission.

string title = 2;

Parameter
Name Description
value String

The title to set.

Returns
Type Description
Permission.Builder

This builder for chaining.

setTitleBytes(ByteString value)

public Permission.Builder setTitleBytes(ByteString value)

The title of this Permission.

string title = 2;

Parameter
Name Description
value ByteString

The bytes for title to set.

Returns
Type Description
Permission.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Permission.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Permission.Builder
Overrides