View Source GoogleApi.ResourceSettings.V1.Api.Projects (google_api_resource_settings v0.3.0)

API calls for all endpoints tagged Projects.

Summary

Functions

Returns a specified setting. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting does not exist.

Lists all the settings that are available on the Cloud resource parent.

Updates a specified setting. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting does not exist. Returns a google.rpc.Status with google.rpc.Code.FAILED_PRECONDITION if the setting is flagged as read only. Returns a google.rpc.Status with google.rpc.Code.ABORTED if the etag supplied in the request does not match the persisted etag of the setting value. On success, the response will contain only name, local_value and etag. The metadata and effective_value cannot be updated through this API. Note: the supplied setting will perform a full overwrite of the local_value field.

Functions

Link to this function

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

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

Returns a specified setting. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting does not exist.

Parameters

  • connection (type: GoogleApi.ResourceSettings.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the setting to get. See Setting for naming requirements.
  • 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").
    • :view (type: String.t) - The SettingView for this request.
  • opts (type: keyword()) - Call options

Returns

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

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

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

Lists all the settings that are available on the Cloud resource parent.

Parameters

  • connection (type: GoogleApi.ResourceSettings.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The project, folder, or organization that is the parent resource for this setting. Must be in one of the following forms: projects/{project_number} projects/{project_id} folders/{folder_id} organizations/{organization_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()) - Unused. The size of the page to be returned.
    • :pageToken (type: String.t) - Unused. A page token used to retrieve the next page.
    • :view (type: String.t) - The SettingView for this request.
  • opts (type: keyword()) - Call options

Returns

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

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

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

Updates a specified setting. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting does not exist. Returns a google.rpc.Status with google.rpc.Code.FAILED_PRECONDITION if the setting is flagged as read only. Returns a google.rpc.Status with google.rpc.Code.ABORTED if the etag supplied in the request does not match the persisted etag of the setting value. On success, the response will contain only name, local_value and etag. The metadata and effective_value cannot be updated through this API. Note: the supplied setting will perform a full overwrite of the local_value field.

Parameters

  • connection (type: GoogleApi.ResourceSettings.V1.Connection.t) - Connection to server
  • name (type: String.t) - The resource name of the setting. Must be in one of the following forms: projects/{project_number}/settings/{setting_name} folders/{folder_id}/settings/{setting_name} * organizations/{organization_id}/settings/{setting_name} For example, "/projects/123/settings/gcp-enableMyFeature"
  • 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.ResourceSettings.V1.Model.GoogleCloudResourcesettingsV1Setting.t) -
  • opts (type: keyword()) - Call options

Returns

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