Dataproc Metastore API (metastore:v1alpha)

2022-04-30

8 removed methods

Deletions

    Methods
  • metastore.projects.locations.federations.setIamPolicy

      HTTP Method: POST

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}:setIamPolicy

      Path: v1alpha/{+resource}:setIamPolicy

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        resource

          Type: string

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/federations/[^/]+$

          Location: path

          Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

      Description: Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

      Parameter Order: resource

  • metastore.projects.locations.federations.patch

      Description: Updates the fields of a federation.

      Parameters:

        updateMask

          Format: google-fieldmask

          Type: string

          Location: query

          Description: Required. A field mask used to specify the fields to be overwritten in the metastore federation resource by the update. Fields specified in the update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.

        requestId

          Type: string

          Description: Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

          Location: query

        name

          Description: Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.

          Pattern: ^projects/[^/]+/locations/[^/]+/federations/[^/]+$

          Type: string

          Location: path

          Required: Yes

      Path: v1alpha/{+name}

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}

      HTTP Method: PATCH

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • metastore.projects.locations.federations.delete

      Parameters:

        requestId

          Type: string

          Location: query

          Description: Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

        name

          Location: path

          Type: string

          Description: Required. The relative resource name of the metastore federation to delete, in the following form:projects/{project_number}/locations/{location_id}/federations/{federation_id}.

          Pattern: ^projects/[^/]+/locations/[^/]+/federations/[^/]+$

          Required: Yes

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}

      Path: v1alpha/{+name}

      Parameter Order: name

      HTTP Method: DELETE

      Description: Deletes a single federation.

  • metastore.projects.locations.federations.get

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}

      Description: Gets the details of a single federation.

      HTTP Method: GET

      Parameter Order: name

      Parameters:

        name

          Pattern: ^projects/[^/]+/locations/[^/]+/federations/[^/]+$

          Location: path

          Required: Yes

          Description: Required. The relative resource name of the metastore federation to retrieve, in the following form:projects/{project_number}/locations/{location_id}/federations/{federation_id}.

          Type: string

      Path: v1alpha/{+name}

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • metastore.projects.locations.federations.list

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/federations

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: parent

      Path: v1alpha/{+parent}/federations

      Description: Lists federations in a project and location.

      Parameters:

        orderBy

          Location: query

          Type: string

          Description: Optional. Specify the ordering of results as described in Sorting Order (https://cloud.google.com/apis/design/design_patterns#sorting_order). If not specified, the results will be sorted in the default order.

        pageToken

          Location: query

          Type: string

          Description: Optional. A page token, received from a previous ListFederationServices call. Provide this token to retrieve the subsequent page.To retrieve the first page, supply an empty page token.When paginating, other parameters provided to ListFederationServices must match the call that provided the page token.

        filter

          Type: string

          Description: Optional. The filter to apply to list results.

          Location: query

        pageSize

          Location: query

          Type: integer

          Description: Optional. The maximum number of federations to return. The response may contain less than the maximum number. If unspecified, no more than 500 services are returned. The maximum value is 1000; values above 1000 are changed to 1000.

          Format: int32

        parent

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Location: path

          Type: string

          Description: Required. The relative resource name of the location of metastore federations to list, in the following form: projects/{project_number}/locations/{location_id}.

  • metastore.projects.locations.federations.testIamPermissions

      Path: v1alpha/{+resource}:testIamPermissions

      Parameter Order: resource

      HTTP Method: POST

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}:testIamPermissions

      Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

      Parameters:

        resource

          Location: path

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/federations/[^/]+$

          Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

          Type: string

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • metastore.projects.locations.federations.getIamPolicy

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

      Path: v1alpha/{+resource}:getIamPolicy

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}:getIamPolicy

      Parameters:

        options.requestedPolicyVersion

          Format: int32

          Type: integer

          Location: query

          Description: Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

        resource

          Required: Yes

          Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/federations/[^/]+$

          Type: string

      Parameter Order: resource

      HTTP Method: GET

  • metastore.projects.locations.federations.create

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/federations

      Parameter Order: parent

      Description: Creates a metastore federation in a project and location.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        parent

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Type: string

          Location: path

          Description: Required. The relative resource name of the location in which to create a federation service, in the following form:projects/{project_number}/locations/{location_id}.

        federationId

          Type: string

          Description: Required. The ID of the metastore federation, which is used as the final component of the metastore federation's name.This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.

          Location: query

        requestId

          Description: Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

          Type: string

          Location: query

      HTTP Method: POST

      Path: v1alpha/{+parent}/federations

8 new methods

Additions

    Methods
  • metastore.projects.locations.federations.setIamPolicy

      HTTP Method: POST

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}:setIamPolicy

      Path: v1alpha/{+resource}:setIamPolicy

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        resource

          Type: string

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/federations/[^/]+$

          Location: path

          Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

      Description: Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

      Parameter Order: resource

  • metastore.projects.locations.federations.patch

      Description: Updates the fields of a federation.

      Parameters:

        updateMask

          Format: google-fieldmask

          Type: string

          Location: query

          Description: Required. A field mask used to specify the fields to be overwritten in the metastore federation resource by the update. Fields specified in the update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.

        requestId

          Type: string

          Description: Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

          Location: query

        name

          Description: Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.

          Pattern: ^projects/[^/]+/locations/[^/]+/federations/[^/]+$

          Type: string

          Location: path

          Required: Yes

      Path: v1alpha/{+name}

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}

      HTTP Method: PATCH

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • metastore.projects.locations.federations.delete

      Parameters:

        requestId

          Type: string

          Location: query

          Description: Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

        name

          Location: path

          Type: string

          Description: Required. The relative resource name of the metastore federation to delete, in the following form:projects/{project_number}/locations/{location_id}/federations/{federation_id}.

          Pattern: ^projects/[^/]+/locations/[^/]+/federations/[^/]+$

          Required: Yes

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}

      Path: v1alpha/{+name}

      Parameter Order: name

      HTTP Method: DELETE

      Description: Deletes a single federation.

  • metastore.projects.locations.federations.get

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}

      Description: Gets the details of a single federation.

      HTTP Method: GET

      Parameter Order: name

      Parameters:

        name

          Pattern: ^projects/[^/]+/locations/[^/]+/federations/[^/]+$

          Location: path

          Required: Yes

          Description: Required. The relative resource name of the metastore federation to retrieve, in the following form:projects/{project_number}/locations/{location_id}/federations/{federation_id}.

          Type: string

      Path: v1alpha/{+name}

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • metastore.projects.locations.federations.list

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/federations

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: parent

      Path: v1alpha/{+parent}/federations

      Description: Lists federations in a project and location.

      Parameters:

        orderBy

          Location: query

          Type: string

          Description: Optional. Specify the ordering of results as described in Sorting Order (https://cloud.google.com/apis/design/design_patterns#sorting_order). If not specified, the results will be sorted in the default order.

        pageToken

          Location: query

          Type: string

          Description: Optional. A page token, received from a previous ListFederationServices call. Provide this token to retrieve the subsequent page.To retrieve the first page, supply an empty page token.When paginating, other parameters provided to ListFederationServices must match the call that provided the page token.

        filter

          Type: string

          Description: Optional. The filter to apply to list results.

          Location: query

        pageSize

          Location: query

          Type: integer

          Description: Optional. The maximum number of federations to return. The response may contain less than the maximum number. If unspecified, no more than 500 services are returned. The maximum value is 1000; values above 1000 are changed to 1000.

          Format: int32

        parent

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Location: path

          Type: string

          Description: Required. The relative resource name of the location of metastore federations to list, in the following form: projects/{project_number}/locations/{location_id}.

  • metastore.projects.locations.federations.testIamPermissions

      Path: v1alpha/{+resource}:testIamPermissions

      Parameter Order: resource

      HTTP Method: POST

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}:testIamPermissions

      Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

      Parameters:

        resource

          Location: path

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/federations/[^/]+$

          Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

          Type: string

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • metastore.projects.locations.federations.getIamPolicy

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

      Path: v1alpha/{+resource}:getIamPolicy

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}:getIamPolicy

      Parameters:

        options.requestedPolicyVersion

          Format: int32

          Type: integer

          Location: query

          Description: Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

        resource

          Required: Yes

          Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/federations/[^/]+$

          Type: string

      Parameter Order: resource

      HTTP Method: GET

  • metastore.projects.locations.federations.create

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/federations

      Parameter Order: parent

      Description: Creates a metastore federation in a project and location.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        parent

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Type: string

          Location: path

          Description: Required. The relative resource name of the location in which to create a federation service, in the following form:projects/{project_number}/locations/{location_id}.

        federationId

          Type: string

          Description: Required. The ID of the metastore federation, which is used as the final component of the metastore federation's name.This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.

          Location: query

        requestId

          Description: Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

          Type: string

          Location: query

      HTTP Method: POST

      Path: v1alpha/{+parent}/federations