Package com.google.iam.admin.v1

Interface GetRoleRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    GetRoleRequest, GetRoleRequest.Builder
    public interface GetRoleRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getName()
      The `name` parameter's value depends on the target resource for the request, namely [`roles`](https://cloud.google.com/iam/reference/rest/v1/roles), [`projects`](https://cloud.google.com/iam/reference/rest/v1/projects.roles), or [`organizations`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles).
      com.google.protobuf.ByteString getNameBytes()
      The `name` parameter's value depends on the target resource for the request, namely [`roles`](https://cloud.google.com/iam/reference/rest/v1/roles), [`projects`](https://cloud.google.com/iam/reference/rest/v1/projects.roles), or [`organizations`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles).

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getName

        String getName()
         The `name` parameter's value depends on the target resource for the
 request, namely
 [`roles`](https://cloud.google.com/iam/reference/rest/v1/roles),
 [`projects`](https://cloud.google.com/iam/reference/rest/v1/projects.roles),
 or
 [`organizations`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles).
 Each resource type's `name` value format is described below:

 * [`roles.get()`](https://cloud.google.com/iam/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`.
   This method returns results from all
   [predefined
   roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles)
   in Cloud IAM. Example request URL:
   `https://iam.googleapis.com/v1/roles/{ROLE_NAME}`

 * [`projects.roles.get()`](https://cloud.google.com/iam/reference/rest/v1/projects.roles/get):
   `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only
   [custom
   roles](https://cloud.google.com/iam/docs/understanding-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()`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles/get):
   `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
   returns only [custom
   roles](https://cloud.google.com/iam/docs/understanding-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:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         The `name` parameter's value depends on the target resource for the
 request, namely
 [`roles`](https://cloud.google.com/iam/reference/rest/v1/roles),
 [`projects`](https://cloud.google.com/iam/reference/rest/v1/projects.roles),
 or
 [`organizations`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles).
 Each resource type's `name` value format is described below:

 * [`roles.get()`](https://cloud.google.com/iam/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`.
   This method returns results from all
   [predefined
   roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles)
   in Cloud IAM. Example request URL:
   `https://iam.googleapis.com/v1/roles/{ROLE_NAME}`

 * [`projects.roles.get()`](https://cloud.google.com/iam/reference/rest/v1/projects.roles/get):
   `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only
   [custom
   roles](https://cloud.google.com/iam/docs/understanding-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()`](https://cloud.google.com/iam/reference/rest/v1/organizations.roles/get):
   `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
   returns only [custom
   roles](https://cloud.google.com/iam/docs/understanding-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:
        The bytes for name.