public final class GetRoleRequest extends GeneratedMessageV3 implements GetRoleRequestOrBuilder
The request to get the definition of an existing role.
Protobuf type google.iam.admin.v1.GetRoleRequest
Static Fields
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static GetRoleRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static GetRoleRequest.Builder newBuilder()
Returns
newBuilder(GetRoleRequest prototype)
public static GetRoleRequest.Builder newBuilder(GetRoleRequest prototype)
Parameter
Returns
public static GetRoleRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static GetRoleRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static GetRoleRequest parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GetRoleRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static GetRoleRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GetRoleRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static GetRoleRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static GetRoleRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static GetRoleRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static GetRoleRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static GetRoleRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GetRoleRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<GetRoleRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public GetRoleRequest getDefaultInstanceForType()
Returns
getName()
The name
parameter's value depends on the target resource for the
request, namely
roles
,
projects
, or
organizations
. Each
resource type's name
value format is described below:
roles.get()
: roles/{ROLE_NAME}
.
This method returns results from all
predefined roles in
Cloud IAM. Example request URL:
https://iam.googleapis.com/v1/roles/{ROLE_NAME}
projects.roles.get()
:
projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}
. This method returns only
custom roles that have been
created at the project level. Example request URL:
https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}
organizations.roles.get()
:
organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}
. This method
returns only custom roles that
have been created at the organization level. Example request URL:
https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}
Note: Wildcard (*) values are invalid; you must specify a complete project
ID or organization ID.
string name = 1 [(.google.api.resource_reference) = { ... }
Returns
Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
The name
parameter's value depends on the target resource for the
request, namely
roles
,
projects
, or
organizations
. Each
resource type's name
value format is described below:
roles.get()
: roles/{ROLE_NAME}
.
This method returns results from all
predefined roles in
Cloud IAM. Example request URL:
https://iam.googleapis.com/v1/roles/{ROLE_NAME}
projects.roles.get()
:
projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}
. This method returns only
custom roles that have been
created at the project level. Example request URL:
https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}
organizations.roles.get()
:
organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}
. This method
returns only custom roles that
have been created at the organization level. Example request URL:
https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}
Note: Wildcard (*) values are invalid; you must specify a complete project
ID or organization ID.
string name = 1 [(.google.api.resource_reference) = { ... }
Returns
getParserForType()
public Parser<GetRoleRequest> 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 GetRoleRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected GetRoleRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public GetRoleRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions