GoogleApi.PolicySimulator.V1.Api.Organizations (google_api_policy_simulator v0.2.0) View Source

API calls for all endpoints tagged Organizations.

Link to this section Summary

Link to this section Functions

Link to this function

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

View Source

Specs

policysimulator_organizations_locations_replays_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.PolicySimulator.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates and starts a Replay using the given ReplayConfig.

Parameters

  • connection (type: GoogleApi.PolicySimulator.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent resource where this Replay will be created. This resource must be a project, folder, or organization with a location. Example: projects/my-example-project/locations/global
  • 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.PolicySimulator.V1.Model.GoogleCloudPolicysimulatorV1Replay.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

policysimulator_organizations_locations_replays_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.PolicySimulator.V1.Model.GoogleCloudPolicysimulatorV1Replay.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the specified Replay. Each Replay is available for at least 7 days.

Parameters

  • connection (type: GoogleApi.PolicySimulator.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the Replay to retrieve, in the following format: {projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}, where {resource-id} is the ID of the project, folder, or organization that owns the Replay. Example: projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36
  • 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.PolicySimulator.V1.Model.GoogleCloudPolicysimulatorV1Replay{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Specs

policysimulator_organizations_locations_replays_results_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.PolicySimulator.V1.Model.GoogleCloudPolicysimulatorV1ListReplayResultsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the results of running a Replay.

Parameters

  • connection (type: GoogleApi.PolicySimulator.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The Replay whose results are listed, in the following format: {projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id} Example: projects/my-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36
  • 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()) - The maximum number of ReplayResult objects to return. Defaults to 5000. The maximum value is 5000; values above 5000 are rounded down to 5000.
    • :pageToken (type: String.t) - A page token, received from a previous Simulator.ListReplayResults call. Provide this token to retrieve the next page of results. When paginating, all other parameters provided to [Simulator.ListReplayResults[] must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

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