View Source GoogleApi.Compute.V1.Api.FirewallPolicies (google_api_compute v0.56.2)

API calls for all endpoints tagged FirewallPolicies.

Summary

Functions

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Creates a new policy in the specified project using the data included in the request.

Lists all the policies that have been configured for the specified folder or organization.

Lists associations of a specified target, i.e., organization or folder.

Patches the specified policy with the data included in the request.

Sets the access control policy on the specified resource. Replaces any existing policy.

Functions

Link to this function

compute_firewall_policies_add_association(connection, firewall_policy, optional_params \\ [], opts \\ [])

View Source
@spec compute_firewall_policies_add_association(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Compute.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Inserts an association for the specified firewall policy.

Parameters

  • connection (type: GoogleApi.Compute.V1.Connection.t) - Connection to server
  • firewall_policy (type: String.t) - Name of the firewall policy to update.
  • 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").
    • :userIp (type: String.t) - Legacy name for parameter that has been superseded by quotaUser.
    • :replaceExistingAssociation (type: boolean()) - Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.
    • :requestId (type: String.t) - An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    • :body (type: GoogleApi.Compute.V1.Model.FirewallPolicyAssociation.t) -
  • opts (type: keyword()) - Call options

Returns

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

compute_firewall_policies_add_rule(connection, firewall_policy, optional_params \\ [], opts \\ [])

View Source
@spec compute_firewall_policies_add_rule(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Compute.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Inserts a rule into a firewall policy.

Parameters

  • connection (type: GoogleApi.Compute.V1.Connection.t) - Connection to server
  • firewall_policy (type: String.t) - Name of the firewall policy to update.
  • 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").
    • :userIp (type: String.t) - Legacy name for parameter that has been superseded by quotaUser.
    • :requestId (type: String.t) - An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    • :body (type: GoogleApi.Compute.V1.Model.FirewallPolicyRule.t) -
  • opts (type: keyword()) - Call options

Returns

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

compute_firewall_policies_clone_rules(connection, firewall_policy, optional_params \\ [], opts \\ [])

View Source
@spec compute_firewall_policies_clone_rules(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Compute.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Copies rules to the specified firewall policy.

Parameters

  • connection (type: GoogleApi.Compute.V1.Connection.t) - Connection to server
  • firewall_policy (type: String.t) - Name of the firewall policy to update.
  • 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").
    • :userIp (type: String.t) - Legacy name for parameter that has been superseded by quotaUser.
    • :requestId (type: String.t) - An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    • :sourceFirewallPolicy (type: String.t) - The firewall policy from which to copy rules.
  • opts (type: keyword()) - Call options

Returns

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

compute_firewall_policies_delete(connection, firewall_policy, optional_params \\ [], opts \\ [])

View Source
@spec compute_firewall_policies_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Compute.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the specified policy.

Parameters

  • connection (type: GoogleApi.Compute.V1.Connection.t) - Connection to server
  • firewall_policy (type: String.t) - Name of the firewall policy to delete.
  • 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").
    • :userIp (type: String.t) - Legacy name for parameter that has been superseded by quotaUser.
    • :requestId (type: String.t) - An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
  • opts (type: keyword()) - Call options

Returns

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

compute_firewall_policies_get(connection, firewall_policy, optional_params \\ [], opts \\ [])

View Source
@spec compute_firewall_policies_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Compute.V1.Model.FirewallPolicy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the specified firewall policy.

Parameters

  • connection (type: GoogleApi.Compute.V1.Connection.t) - Connection to server
  • firewall_policy (type: String.t) - Name of the firewall policy 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").
    • :userIp (type: String.t) - Legacy name for parameter that has been superseded by quotaUser.
  • opts (type: keyword()) - Call options

Returns

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

compute_firewall_policies_get_association(connection, firewall_policy, optional_params \\ [], opts \\ [])

View Source
@spec compute_firewall_policies_get_association(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Compute.V1.Model.FirewallPolicyAssociation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets an association with the specified name.

Parameters

  • connection (type: GoogleApi.Compute.V1.Connection.t) - Connection to server
  • firewall_policy (type: String.t) - Name of the firewall policy to which the queried rule belongs.
  • 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").
    • :userIp (type: String.t) - Legacy name for parameter that has been superseded by quotaUser.
    • :name (type: String.t) - The name of the association to get from the firewall policy.
  • opts (type: keyword()) - Call options

Returns

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

compute_firewall_policies_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])

View Source
@spec compute_firewall_policies_get_iam_policy(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Compute.V1.Model.Policy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters

  • connection (type: GoogleApi.Compute.V1.Connection.t) - Connection to server
  • resource (type: String.t) - Name or id of the resource for this request.
  • 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").
    • :userIp (type: String.t) - Legacy name for parameter that has been superseded by quotaUser.
    • :optionsRequestedPolicyVersion (type: integer()) - Requested IAM Policy version.
  • opts (type: keyword()) - Call options

Returns

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

compute_firewall_policies_get_rule(connection, firewall_policy, optional_params \\ [], opts \\ [])

View Source
@spec compute_firewall_policies_get_rule(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Compute.V1.Model.FirewallPolicyRule.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a rule of the specified priority.

Parameters

  • connection (type: GoogleApi.Compute.V1.Connection.t) - Connection to server
  • firewall_policy (type: String.t) - Name of the firewall policy to which the queried rule belongs.
  • 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").
    • :userIp (type: String.t) - Legacy name for parameter that has been superseded by quotaUser.
    • :priority (type: integer()) - The priority of the rule to get from the firewall policy.
  • opts (type: keyword()) - Call options

Returns

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

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

View Source
@spec compute_firewall_policies_insert(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Compute.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new policy in the specified project using the data included in the request.

Parameters

  • connection (type: GoogleApi.Compute.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").
    • :userIp (type: String.t) - Legacy name for parameter that has been superseded by quotaUser.
    • :parentId (type: String.t) - Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization.
    • :requestId (type: String.t) - An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    • :body (type: GoogleApi.Compute.V1.Model.FirewallPolicy.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

View Source
@spec compute_firewall_policies_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Compute.V1.Model.FirewallPolicyList.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all the policies that have been configured for the specified folder or organization.

Parameters

  • connection (type: GoogleApi.Compute.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").
    • :userIp (type: String.t) - Legacy name for parameter that has been superseded by quotaUser.
    • :filter (type: String.t) - A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, !=, >, <, <=, >= or :. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.
    • :maxResults (type: integer()) - The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
    • :orderBy (type: String.t) - Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
    • :pageToken (type: String.t) - Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • :parentId (type: String.t) - Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization.
    • :returnPartialSuccess (type: boolean()) - Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
  • opts (type: keyword()) - Call options

Returns

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

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

View Source
@spec compute_firewall_policies_list_associations(
  Tesla.Env.client(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Compute.V1.Model.FirewallPoliciesListAssociationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists associations of a specified target, i.e., organization or folder.

Parameters

  • connection (type: GoogleApi.Compute.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").
    • :userIp (type: String.t) - Legacy name for parameter that has been superseded by quotaUser.
    • :targetResource (type: String.t) - The target resource to list associations. It is an organization, or a folder.
  • opts (type: keyword()) - Call options

Returns

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

compute_firewall_policies_move(connection, firewall_policy, optional_params \\ [], opts \\ [])

View Source
@spec compute_firewall_policies_move(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Compute.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Moves the specified firewall policy.

Parameters

  • connection (type: GoogleApi.Compute.V1.Connection.t) - Connection to server
  • firewall_policy (type: String.t) - Name of the firewall policy to update.
  • 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").
    • :userIp (type: String.t) - Legacy name for parameter that has been superseded by quotaUser.
    • :parentId (type: String.t) - The new parent of the firewall policy. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization.
    • :requestId (type: String.t) - An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
  • opts (type: keyword()) - Call options

Returns

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

compute_firewall_policies_patch(connection, firewall_policy, optional_params \\ [], opts \\ [])

View Source
@spec compute_firewall_policies_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Compute.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Patches the specified policy with the data included in the request.

Parameters

  • connection (type: GoogleApi.Compute.V1.Connection.t) - Connection to server
  • firewall_policy (type: String.t) - Name of the firewall policy to update.
  • 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").
    • :userIp (type: String.t) - Legacy name for parameter that has been superseded by quotaUser.
    • :requestId (type: String.t) - An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    • :body (type: GoogleApi.Compute.V1.Model.FirewallPolicy.t) -
  • opts (type: keyword()) - Call options

Returns

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

compute_firewall_policies_patch_rule(connection, firewall_policy, optional_params \\ [], opts \\ [])

View Source
@spec compute_firewall_policies_patch_rule(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Compute.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Patches a rule of the specified priority.

Parameters

  • connection (type: GoogleApi.Compute.V1.Connection.t) - Connection to server
  • firewall_policy (type: String.t) - Name of the firewall policy to update.
  • 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").
    • :userIp (type: String.t) - Legacy name for parameter that has been superseded by quotaUser.
    • :priority (type: integer()) - The priority of the rule to patch.
    • :requestId (type: String.t) - An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    • :body (type: GoogleApi.Compute.V1.Model.FirewallPolicyRule.t) -
  • opts (type: keyword()) - Call options

Returns

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

compute_firewall_policies_remove_association(connection, firewall_policy, optional_params \\ [], opts \\ [])

View Source
@spec compute_firewall_policies_remove_association(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Compute.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Removes an association for the specified firewall policy.

Parameters

  • connection (type: GoogleApi.Compute.V1.Connection.t) - Connection to server
  • firewall_policy (type: String.t) - Name of the firewall policy to update.
  • 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").
    • :userIp (type: String.t) - Legacy name for parameter that has been superseded by quotaUser.
    • :name (type: String.t) - Name for the attachment that will be removed.
    • :requestId (type: String.t) - An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
  • opts (type: keyword()) - Call options

Returns

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

compute_firewall_policies_remove_rule(connection, firewall_policy, optional_params \\ [], opts \\ [])

View Source
@spec compute_firewall_policies_remove_rule(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Compute.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a rule of the specified priority.

Parameters

  • connection (type: GoogleApi.Compute.V1.Connection.t) - Connection to server
  • firewall_policy (type: String.t) - Name of the firewall policy to update.
  • 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").
    • :userIp (type: String.t) - Legacy name for parameter that has been superseded by quotaUser.
    • :priority (type: integer()) - The priority of the rule to remove from the firewall policy.
    • :requestId (type: String.t) - An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
  • opts (type: keyword()) - Call options

Returns

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

compute_firewall_policies_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])

View Source
@spec compute_firewall_policies_set_iam_policy(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Compute.V1.Model.Policy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters

  • connection (type: GoogleApi.Compute.V1.Connection.t) - Connection to server
  • resource (type: String.t) - Name or id of the resource for this request.
  • 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").
    • :userIp (type: String.t) - Legacy name for parameter that has been superseded by quotaUser.
    • :body (type: GoogleApi.Compute.V1.Model.GlobalOrganizationSetPolicyRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

compute_firewall_policies_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])

View Source
@spec compute_firewall_policies_test_iam_permissions(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Compute.V1.Model.TestPermissionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns permissions that a caller has on the specified resource.

Parameters

  • connection (type: GoogleApi.Compute.V1.Connection.t) - Connection to server
  • resource (type: String.t) - Name or id of the resource for this request.
  • 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").
    • :userIp (type: String.t) - Legacy name for parameter that has been superseded by quotaUser.
    • :body (type: GoogleApi.Compute.V1.Model.TestPermissionsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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