View Source GoogleApi.AdvisoryNotifications.V1.Api.Organizations (google_api_advisory_notifications v0.4.0)

API calls for all endpoints tagged Organizations.

Summary

Functions

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

Get notification settings.

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

Gets a notification.

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

Lists notifications under a given parent.

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

Update notification settings.

Functions

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

@spec advisorynotifications_organizations_locations_get_settings(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AdvisoryNotifications.V1.Model.GoogleCloudAdvisorynotificationsV1Settings.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get notification settings.

Parameters

connection (type: GoogleApi.AdvisoryNotifications.V1.Connection.t) - Connection to server
name (type: String.t) - Required. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.
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.AdvisoryNotifications.V1.Model.GoogleCloudAdvisorynotificationsV1Settings{}} on success
{:error, info} on failure

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

@spec advisorynotifications_organizations_locations_notifications_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AdvisoryNotifications.V1.Model.GoogleCloudAdvisorynotificationsV1Notification.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a notification.

Parameters

connection (type: GoogleApi.AdvisoryNotifications.V1.Connection.t) - Connection to server
name (type: String.t) - Required. A name of the notification to retrieve. Format: organizations/{organization}/locations/{location}/notifications/{notification} or projects/{projects}/locations/{location}/notifications/{notification}.
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").
- :languageCode (type: String.t) - ISO code for requested localization language. If unset, will be interpereted as "en". If the requested language is valid, but not supported for this notification, English will be returned with an "Not applicable" LocalizationState. If the ISO code is invalid (i.e. not a real language), this RPC will throw an error.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.AdvisoryNotifications.V1.Model.GoogleCloudAdvisorynotificationsV1Notification{}} on success
{:error, info} on failure

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

@spec advisorynotifications_organizations_locations_notifications_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AdvisoryNotifications.V1.Model.GoogleCloudAdvisorynotificationsV1ListNotificationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists notifications under a given parent.

Parameters

connection (type: GoogleApi.AdvisoryNotifications.V1.Connection.t) - Connection to server
parent (type: String.t) - Required. The parent, which owns this collection of notifications. Must be of the form "organizations/{organization}/locations/{location}" or "projects/{project}/locations/{location}".
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").
- :languageCode (type: String.t) - ISO code for requested localization language. If unset, will be interpereted as "en". If the requested language is valid, but not supported for this notification, English will be returned with an "Not applicable" LocalizationState. If the ISO code is invalid (i.e. not a real language), this RPC will throw an error.
- :pageSize (type: integer()) - The maximum number of notifications to return. The service may return fewer than this value. If unspecified or equal to 0, at most 50 notifications will be returned. The maximum value is 50; values above 50 will be coerced to 50.
- :pageToken (type: String.t) - A page token returned from a previous request. When paginating, all other parameters provided in the request must match the call that returned the page token.
- :view (type: String.t) - Specifies which parts of the notification resource should be returned in the response.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.AdvisoryNotifications.V1.Model.GoogleCloudAdvisorynotificationsV1ListNotificationsResponse{}} on success
{:error, info} on failure

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

@spec advisorynotifications_organizations_locations_update_settings(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AdvisoryNotifications.V1.Model.GoogleCloudAdvisorynotificationsV1Settings.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Update notification settings.

Parameters

connection (type: GoogleApi.AdvisoryNotifications.V1.Connection.t) - Connection to server
name (type: String.t) - Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.
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.AdvisoryNotifications.V1.Model.GoogleCloudAdvisorynotificationsV1Settings.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.AdvisoryNotifications.V1.Model.GoogleCloudAdvisorynotificationsV1Settings{}} on success
{:error, info} on failure