google_api_access_context_manager v0.10.0 GoogleApi.AccessContextManager.V1.Api.AccessPolicies View Source

API calls for all endpoints tagged AccessPolicies.

Link to this section Summary

Functions

Create an Access Level. The longrunning operation from this RPC will have a successful status once the Access Level has propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.

Delete an Access Level by resource name. The longrunning operation from this RPC will have a successful status once the Access Level has been removed from long-lasting storage.

Update an Access Level. The longrunning operation from this RPC will have a successful status once the changes to the Access Level have propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.

Replace all existing Access Levels in an Access Policy with the Access Levels provided. This is done atomically. The longrunning operation from this RPC will have a successful status once all replacements have propagated to long-lasting storage. Replacements containing errors will result in an error response for the first error encountered. Replacement will be cancelled on error, existing Access Levels will not be affected. Operation.response field will contain ReplaceAccessLevelsResponse. Removing Access Levels contained in existing Service Perimeters will result in error.

Create an AccessPolicy. Fails if this organization already has a AccessPolicy. The longrunning Operation will have a successful status once the AccessPolicy has propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in metadata as a BadRequest proto.

Delete an AccessPolicy by resource name. The longrunning Operation will have a successful status once the AccessPolicy has been removed from long-lasting storage.

Update an AccessPolicy. The longrunning Operation from this RPC will have a successful status once the changes to the AccessPolicy have propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in metadata as a BadRequest proto.

Commit the dry-run spec for all the Service Perimeters in an Access Policy. A commit operation on a Service Perimeter involves copying its spec field to that Service Perimeter's status field. Only Service Perimeters with use_explicit_dry_run_spec field set to true are affected by a commit operation. The longrunning operation from this RPC will have a successful status once the dry-run specs for all the Service Perimeters have been committed. If a commit fails, it will cause the longrunning operation to return an error response and the entire commit operation will be cancelled. When successful, Operation.response field will contain CommitServicePerimetersResponse. The dry_run and the spec fields will be cleared after a successful commit operation.

Create a Service Perimeter. The longrunning operation from this RPC will have a successful status once the Service Perimeter has propagated to long-lasting storage. Service Perimeters containing errors will result in an error response for the first error encountered.

Delete a Service Perimeter by resource name. The longrunning operation from this RPC will have a successful status once the Service Perimeter has been removed from long-lasting storage.

Update a Service Perimeter. The longrunning operation from this RPC will have a successful status once the changes to the Service Perimeter have propagated to long-lasting storage. Service Perimeter containing errors will result in an error response for the first error encountered.

Replace all existing Service Perimeters in an Access Policy with the Service Perimeters provided. This is done atomically. The longrunning operation from this RPC will have a successful status once all replacements have propagated to long-lasting storage. Replacements containing errors will result in an error response for the first error encountered. Replacement will be cancelled on error, existing Service Perimeters will not be affected. Operation.response field will contain ReplaceServicePerimetersResponse.

Link to this section Functions

Link to this function

accesscontextmanager_access_policies_access_levels_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
accesscontextmanager_access_policies_access_levels_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AccessContextManager.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Create an Access Level. The longrunning operation from this RPC will have a successful status once the Access Level has propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.

Parameters

  • connection (type: GoogleApi.AccessContextManager.V1.Connection.t) - Connection to server

  • parent (type: String.t) - Required. Resource name for the access policy which owns this Access Level.

    Format: accessPolicies/{policy_id}

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.AccessContextManager.V1.Model.AccessLevel.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AccessContextManager.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

accesscontextmanager_access_policies_access_levels_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
accesscontextmanager_access_policies_access_levels_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AccessContextManager.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Delete an Access Level by resource name. The longrunning operation from this RPC will have a successful status once the Access Level has been removed from long-lasting storage.

Parameters

  • connection (type: GoogleApi.AccessContextManager.V1.Connection.t) - Connection to server

  • name (type: String.t) - Required. Resource name for the Access Level.

    Format: accessPolicies/{policy_id}/accessLevels/{access_level_id}

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AccessContextManager.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

accesscontextmanager_access_policies_access_levels_get(connection, name, optional_params \\ [], opts \\ [])

View Source
accesscontextmanager_access_policies_access_levels_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AccessContextManager.V1.Model.AccessLevel.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Get an Access Level by resource name.

Parameters

  • connection (type: GoogleApi.AccessContextManager.V1.Connection.t) - Connection to server

  • name (type: String.t) - Required. Resource name for the Access Level.

    Format: accessPolicies/{policy_id}/accessLevels/{access_level_id}

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :accessLevelFormat (type: String.t) - Whether to return BasicLevels in the Cloud Common Expression Language rather than as BasicLevels. Defaults to AS_DEFINED, where Access Levels are returned as BasicLevels or CustomLevels based on how they were created. If set to CEL, all Access Levels are returned as CustomLevels. In the CEL case, BasicLevels are translated to equivalent CustomLevels.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AccessContextManager.V1.Model.AccessLevel{}} on success
  • {:error, info} on failure
Link to this function

accesscontextmanager_access_policies_access_levels_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
accesscontextmanager_access_policies_access_levels_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AccessContextManager.V1.Model.ListAccessLevelsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

List all Access Levels for an access policy.

Parameters

  • connection (type: GoogleApi.AccessContextManager.V1.Connection.t) - Connection to server

  • parent (type: String.t) - Required. Resource name for the access policy to list Access Levels from.

    Format: accessPolicies/{policy_id}

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :accessLevelFormat (type: String.t) - Whether to return BasicLevels in the Cloud Common Expression language, as CustomLevels, rather than as BasicLevels. Defaults to returning AccessLevels in the format they were defined.
    • :pageSize (type: integer()) - Number of Access Levels to include in the list. Default 100.
    • :pageToken (type: String.t) - Next page token for the next batch of Access Level instances. Defaults to the first page of results.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AccessContextManager.V1.Model.ListAccessLevelsResponse{}} on success
  • {:error, info} on failure
Link to this function

accesscontextmanager_access_policies_access_levels_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
accesscontextmanager_access_policies_access_levels_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AccessContextManager.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Update an Access Level. The longrunning operation from this RPC will have a successful status once the changes to the Access Level have propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.

Parameters

  • connection (type: GoogleApi.AccessContextManager.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Resource name for the Access Level. The short_name component must begin with a letter and only include alphanumeric and '_'. Format: accessPolicies/{policy_id}/accessLevels/{short_name}. The maximum length of the short_name component is 50 characters.
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Required. Mask to control which fields get updated. Must be non-empty.
    • :body (type: GoogleApi.AccessContextManager.V1.Model.AccessLevel.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AccessContextManager.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

accesscontextmanager_access_policies_access_levels_replace_all(connection, parent, optional_params \\ [], opts \\ [])

View Source
accesscontextmanager_access_policies_access_levels_replace_all(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AccessContextManager.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Replace all existing Access Levels in an Access Policy with the Access Levels provided. This is done atomically. The longrunning operation from this RPC will have a successful status once all replacements have propagated to long-lasting storage. Replacements containing errors will result in an error response for the first error encountered. Replacement will be cancelled on error, existing Access Levels will not be affected. Operation.response field will contain ReplaceAccessLevelsResponse. Removing Access Levels contained in existing Service Perimeters will result in error.

Parameters

  • connection (type: GoogleApi.AccessContextManager.V1.Connection.t) - Connection to server

  • parent (type: String.t) - Required. Resource name for the access policy which owns these Access Levels.

    Format: accessPolicies/{policy_id}

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.AccessContextManager.V1.Model.ReplaceAccessLevelsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AccessContextManager.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

accesscontextmanager_access_policies_create(connection, optional_params \\ [], opts \\ [])

View Source
accesscontextmanager_access_policies_create(
  Tesla.Env.client(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AccessContextManager.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Create an AccessPolicy. Fails if this organization already has a AccessPolicy. The longrunning Operation will have a successful status once the AccessPolicy has propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in metadata as a BadRequest proto.

Parameters

  • connection (type: GoogleApi.AccessContextManager.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.AccessContextManager.V1.Model.AccessPolicy.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AccessContextManager.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

accesscontextmanager_access_policies_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
accesscontextmanager_access_policies_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AccessContextManager.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Delete an AccessPolicy by resource name. The longrunning Operation will have a successful status once the AccessPolicy has been removed from long-lasting storage.

Parameters

  • connection (type: GoogleApi.AccessContextManager.V1.Connection.t) - Connection to server

  • name (type: String.t) - Required. Resource name for the access policy to delete.

    Format accessPolicies/{policy_id}

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AccessContextManager.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

accesscontextmanager_access_policies_get(connection, name, optional_params \\ [], opts \\ [])

View Source
accesscontextmanager_access_policies_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AccessContextManager.V1.Model.AccessPolicy.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Get an AccessPolicy by name.

Parameters

  • connection (type: GoogleApi.AccessContextManager.V1.Connection.t) - Connection to server

  • name (type: String.t) - Required. Resource name for the access policy to get.

    Format accessPolicies/{policy_id}

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AccessContextManager.V1.Model.AccessPolicy{}} on success
  • {:error, info} on failure
Link to this function

accesscontextmanager_access_policies_list(connection, optional_params \\ [], opts \\ [])

View Source
accesscontextmanager_access_policies_list(
  Tesla.Env.client(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AccessContextManager.V1.Model.ListAccessPoliciesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

List all AccessPolicies under a container.

Parameters

  • connection (type: GoogleApi.AccessContextManager.V1.Connection.t) - Connection to server

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Number of AccessPolicy instances to include in the list. Default 100.
    • :pageToken (type: String.t) - Next page token for the next batch of AccessPolicy instances. Defaults to the first page of results.
    • :parent (type: String.t) - Required. Resource name for the container to list AccessPolicy instances from.

      Format: organizations/{org_id}

  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AccessContextManager.V1.Model.ListAccessPoliciesResponse{}} on success
  • {:error, info} on failure
Link to this function

accesscontextmanager_access_policies_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
accesscontextmanager_access_policies_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AccessContextManager.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Update an AccessPolicy. The longrunning Operation from this RPC will have a successful status once the changes to the AccessPolicy have propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in metadata as a BadRequest proto.

Parameters

  • connection (type: GoogleApi.AccessContextManager.V1.Connection.t) - Connection to server
  • name (type: String.t) - Output only. Resource name of the AccessPolicy. Format: accessPolicies/{policy_id}
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Required. Mask to control which fields get updated. Must be non-empty.
    • :body (type: GoogleApi.AccessContextManager.V1.Model.AccessPolicy.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AccessContextManager.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

accesscontextmanager_access_policies_service_perimeters_commit(connection, parent, optional_params \\ [], opts \\ [])

View Source
accesscontextmanager_access_policies_service_perimeters_commit(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AccessContextManager.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Commit the dry-run spec for all the Service Perimeters in an Access Policy. A commit operation on a Service Perimeter involves copying its spec field to that Service Perimeter's status field. Only Service Perimeters with use_explicit_dry_run_spec field set to true are affected by a commit operation. The longrunning operation from this RPC will have a successful status once the dry-run specs for all the Service Perimeters have been committed. If a commit fails, it will cause the longrunning operation to return an error response and the entire commit operation will be cancelled. When successful, Operation.response field will contain CommitServicePerimetersResponse. The dry_run and the spec fields will be cleared after a successful commit operation.

Parameters

  • connection (type: GoogleApi.AccessContextManager.V1.Connection.t) - Connection to server

  • parent (type: String.t) - Required. Resource name for the parent Access Policy which owns all Service Perimeters in scope for the commit operation.

    Format: accessPolicies/{policy_id}

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.AccessContextManager.V1.Model.CommitServicePerimetersRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AccessContextManager.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

accesscontextmanager_access_policies_service_perimeters_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
accesscontextmanager_access_policies_service_perimeters_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AccessContextManager.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Create a Service Perimeter. The longrunning operation from this RPC will have a successful status once the Service Perimeter has propagated to long-lasting storage. Service Perimeters containing errors will result in an error response for the first error encountered.

Parameters

  • connection (type: GoogleApi.AccessContextManager.V1.Connection.t) - Connection to server

  • parent (type: String.t) - Required. Resource name for the access policy which owns this Service Perimeter.

    Format: accessPolicies/{policy_id}

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.AccessContextManager.V1.Model.ServicePerimeter.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AccessContextManager.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

accesscontextmanager_access_policies_service_perimeters_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
accesscontextmanager_access_policies_service_perimeters_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AccessContextManager.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Delete a Service Perimeter by resource name. The longrunning operation from this RPC will have a successful status once the Service Perimeter has been removed from long-lasting storage.

Parameters

  • connection (type: GoogleApi.AccessContextManager.V1.Connection.t) - Connection to server

  • name (type: String.t) - Required. Resource name for the Service Perimeter.

    Format: accessPolicies/{policy_id}/servicePerimeters/{service_perimeter_id}

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AccessContextManager.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

accesscontextmanager_access_policies_service_perimeters_get(connection, name, optional_params \\ [], opts \\ [])

View Source
accesscontextmanager_access_policies_service_perimeters_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AccessContextManager.V1.Model.ServicePerimeter.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Get a Service Perimeter by resource name.

Parameters

  • connection (type: GoogleApi.AccessContextManager.V1.Connection.t) - Connection to server

  • name (type: String.t) - Required. Resource name for the Service Perimeter.

    Format: accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AccessContextManager.V1.Model.ServicePerimeter{}} on success
  • {:error, info} on failure
Link to this function

accesscontextmanager_access_policies_service_perimeters_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
accesscontextmanager_access_policies_service_perimeters_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AccessContextManager.V1.Model.ListServicePerimetersResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

List all Service Perimeters for an access policy.

Parameters

  • connection (type: GoogleApi.AccessContextManager.V1.Connection.t) - Connection to server

  • parent (type: String.t) - Required. Resource name for the access policy to list Service Perimeters from.

    Format: accessPolicies/{policy_id}

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Number of Service Perimeters to include in the list. Default 100.
    • :pageToken (type: String.t) - Next page token for the next batch of Service Perimeter instances. Defaults to the first page of results.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AccessContextManager.V1.Model.ListServicePerimetersResponse{}} on success
  • {:error, info} on failure
Link to this function

accesscontextmanager_access_policies_service_perimeters_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
accesscontextmanager_access_policies_service_perimeters_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AccessContextManager.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Update a Service Perimeter. The longrunning operation from this RPC will have a successful status once the changes to the Service Perimeter have propagated to long-lasting storage. Service Perimeter containing errors will result in an error response for the first error encountered.

Parameters

  • connection (type: GoogleApi.AccessContextManager.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Resource name for the ServicePerimeter. The short_name component must begin with a letter and only include alphanumeric and '_'. Format: accessPolicies/{policy_id}/servicePerimeters/{short_name}
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Required. Mask to control which fields get updated. Must be non-empty.
    • :body (type: GoogleApi.AccessContextManager.V1.Model.ServicePerimeter.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AccessContextManager.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

accesscontextmanager_access_policies_service_perimeters_replace_all(connection, parent, optional_params \\ [], opts \\ [])

View Source
accesscontextmanager_access_policies_service_perimeters_replace_all(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AccessContextManager.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Replace all existing Service Perimeters in an Access Policy with the Service Perimeters provided. This is done atomically. The longrunning operation from this RPC will have a successful status once all replacements have propagated to long-lasting storage. Replacements containing errors will result in an error response for the first error encountered. Replacement will be cancelled on error, existing Service Perimeters will not be affected. Operation.response field will contain ReplaceServicePerimetersResponse.

Parameters

  • connection (type: GoogleApi.AccessContextManager.V1.Connection.t) - Connection to server

  • parent (type: String.t) - Required. Resource name for the access policy which owns these Service Perimeters.

    Format: accessPolicies/{policy_id}

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.AccessContextManager.V1.Model.ReplaceServicePerimetersRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AccessContextManager.V1.Model.Operation{}} on success
  • {:error, info} on failure