View Source GoogleApi.PolicySimulator.V1.Api.Organizations (google_api_policy_simulator v0.3.0)
API calls for all endpoints tagged Organizations
.
Summary
Functions
CreateOrgPolicyViolationsPreview creates an OrgPolicyViolationsPreview for the proposed changes in the provided OrgPolicyViolationsPreview.OrgPolicyOverlay. The changes to OrgPolicy are specified by this OrgPolicyOverlay
. The resources to scan are inferred from these specified changes.
GetOrgPolicyViolationsPreview gets the specified OrgPolicyViolationsPreview. Each OrgPolicyViolationsPreview is available for at least 7 days.
ListOrgPolicyViolationsPreviews lists each OrgPolicyViolationsPreview in an organization. Each OrgPolicyViolationsPreview is available for at least 7 days.
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ListOrgPolicyViolations lists the OrgPolicyViolations that are present in an OrgPolicyViolationsPreview.
Creates and starts a Replay using the given ReplayConfig.
Gets the specified Replay. Each Replay
is available for at least 7 days.
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Lists the results of running a Replay.
Functions
policysimulator_organizations_locations_org_policy_violations_previews_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec policysimulator_organizations_locations_org_policy_violations_previews_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.PolicySimulator.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
CreateOrgPolicyViolationsPreview creates an OrgPolicyViolationsPreview for the proposed changes in the provided OrgPolicyViolationsPreview.OrgPolicyOverlay. The changes to OrgPolicy are specified by this OrgPolicyOverlay
. The resources to scan are inferred from these specified changes.
Parameters
-
connection
(type:GoogleApi.PolicySimulator.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The organization under which this OrgPolicyViolationsPreview will be created. Example:organizations/my-example-org/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"). -
:orgPolicyViolationsPreviewId
(type:String.t
) - Optional. An optional user-specified ID for the OrgPolicyViolationsPreview. If not provided, a random ID will be generated. -
:body
(type:GoogleApi.PolicySimulator.V1.Model.GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.PolicySimulator.V1.Model.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
policysimulator_organizations_locations_org_policy_violations_previews_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec policysimulator_organizations_locations_org_policy_violations_previews_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.PolicySimulator.V1.Model.GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
GetOrgPolicyViolationsPreview gets the specified OrgPolicyViolationsPreview. Each OrgPolicyViolationsPreview 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 OrgPolicyViolationsPreview to get. -
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.GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview{}}
on success -
{:error, info}
on failure
policysimulator_organizations_locations_org_policy_violations_previews_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec policysimulator_organizations_locations_org_policy_violations_previews_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.PolicySimulator.V1.Model.GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
ListOrgPolicyViolationsPreviews lists each OrgPolicyViolationsPreview in an organization. Each OrgPolicyViolationsPreview is available for at least 7 days.
Parameters
-
connection
(type:GoogleApi.PolicySimulator.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent the violations are scoped to. Format:organizations/{organization}/locations/{location}
Example:organizations/my-example-org/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"). -
:pageSize
(type:integer()
) - Optional. The maximum number of items to return. The service may return fewer than this value. If unspecified, at most 5 items will be returned. The maximum value is 10; values above 10 will be coerced to 10. -
:pageToken
(type:String.t
) - Optional. A page token, received from a previous call. Provide this to retrieve the subsequent page. When paginating, all other parameters must match the call that provided the page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.PolicySimulator.V1.Model.GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse{}}
on success -
{:error, info}
on failure
policysimulator_organizations_locations_org_policy_violations_previews_operations_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec policysimulator_organizations_locations_org_policy_violations_previews_operations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.PolicySimulator.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters
-
connection
(type:GoogleApi.PolicySimulator.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource. -
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.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
policysimulator_organizations_locations_org_policy_violations_previews_org_policy_violations_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec policysimulator_organizations_locations_org_policy_violations_previews_org_policy_violations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.PolicySimulator.V1.Model.GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
ListOrgPolicyViolations lists the OrgPolicyViolations that are present in an OrgPolicyViolationsPreview.
Parameters
-
connection
(type:GoogleApi.PolicySimulator.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The OrgPolicyViolationsPreview to get OrgPolicyViolations from. Format: organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview} -
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()
) - Optional. The maximum number of items to return. The service may return fewer than this value. If unspecified, at most 50 items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. -
:pageToken
(type:String.t
) - Optional. A page token, received from a previous call. Provide this to retrieve the subsequent page. When paginating, all other parameters must match the call that provided the page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.PolicySimulator.V1.Model.GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsResponse{}}
on success -
{:error, info}
on failure
policysimulator_organizations_locations_replays_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec 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
policysimulator_organizations_locations_replays_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec 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 theReplay
. 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
policysimulator_organizations_locations_replays_operations_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec policysimulator_organizations_locations_replays_operations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.PolicySimulator.V1.Model.GoogleLongrunningOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters
-
connection
(type:GoogleApi.PolicySimulator.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource. -
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.GoogleLongrunningOperation{}}
on success -
{:error, info}
on failure
policysimulator_organizations_locations_replays_operations_list(connection, name, optional_params \\ [], opts \\ [])
View Source@spec policysimulator_organizations_locations_replays_operations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.PolicySimulator.V1.Model.GoogleLongrunningListOperationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters
-
connection
(type:GoogleApi.PolicySimulator.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation's parent resource. -
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"). -
:filter
(type:String.t
) - The standard list filter. -
:pageSize
(type:integer()
) - The standard list page size. -
:pageToken
(type:String.t
) - The standard list page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.PolicySimulator.V1.Model.GoogleLongrunningListOperationsResponse{}}
on success -
{:error, info}
on failure
policysimulator_organizations_locations_replays_results_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec 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