Interface ResourceTypeClient

All Known Implementing Classes:
ResourceTypeClientImpl
public interface ResourceTypeClient
Internal client for the IAM access-model discovery operations (resource types, actions, action sets, resource-type actions, and service policy schemas). All operations are project-scoped GETs; the list-shaped responses use opaque-token (nextPageToken) pagination.

  • Method Details

    • listResourceTypes

      ResourceTypeList listResourceTypes(String projectId, String serviceId, String pageToken, Integer pageSize, String projectErn)
      Lists the registered resource types for a project (operationId listResourceTypes).
      Parameters:
      projectId - the project identifier (path parameter)
      serviceId - the fully qualified service id (required query parameter)
      pageToken - the opaque page token from a prior response, or null
      pageSize - the maximum number of results per page, or null
      projectErn - the project ERN (optional, mutually exclusive with projectId), or null
      Returns:
      the requested page of resource types

    • listActions

      ActionList listActions(String projectId, String serviceId, String pageToken, Integer pageSize, String projectErn)
      Lists the available actions for a project (operationId listActions).
      Parameters:
      projectId - the project identifier (path parameter)
      serviceId - the fully qualified service id (required query parameter)
      pageToken - the opaque page token from a prior response, or null
      pageSize - the maximum number of results per page, or null
      projectErn - the project ERN (optional, mutually exclusive with projectId), or null
      Returns:
      the requested page of actions

    • listActionSets

      ServiceActionSetList listActionSets(String projectId, String serviceId, String pageToken, Integer pageSize, String projectErn)
      Lists the action sets for a service within a project (operationId listActionSets).
      Parameters:
      projectId - the project identifier (path parameter)
      serviceId - the service to list action sets for (required query parameter)
      pageToken - the opaque page token from a prior response, or null
      pageSize - the maximum number of results per page, or null
      projectErn - the project ERN (optional, mutually exclusive with projectId), or null
      Returns:
      the requested page of action sets

    • listResourceTypeActions

      ResourceTypeActionPage listResourceTypeActions(String projectId, String serviceId, String resourceType, String resourceTypeServiceId, String lastAction, Integer pageSize, String projectErn)
      Pages the resource-type-to-action mappings for a project (operationId pageResourceTypeActions).
      Parameters:
      projectId - the project identifier (path parameter)
      serviceId - the fully qualified service id owning the resource type (required query parameter)
      resourceType - the resource type within the service (required query parameter)
      resourceTypeServiceId - the service id of the resource type when different from serviceId, or null
      lastAction - the id of the last action received, used for cursor-based pagination, or null
      pageSize - the maximum number of results per page, or null
      projectErn - the project ERN (optional, mutually exclusive with projectId), or null
      Returns:
      the requested page of resource-type actions

    • getServicePolicySchema

      ServicePolicySchema getServicePolicySchema(String projectId, String serviceId)
      Gets the policy schema for a service within a project (operationId getServicePolicySchema).
      Parameters:
      projectId - the project identifier (path parameter)
      serviceId - the service to fetch the policy schema for (required query parameter)
      Returns:
      the service policy schema