View Source GoogleApi.Monitoring.V3.Api.Services (google_api_monitoring v0.55.0)

@spec monitoring_services_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Monitoring.V3.Model.Service.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Create a Service.

Parameters

connection (type: GoogleApi.Monitoring.V3.Connection.t) - Connection to server
v3_id (type: String.t) - Part of parent. Required. Resource name (https://cloud.google.com/monitoring/api/v3#project_name) of the parent Metrics Scope. The format is: projects/[PROJECT_ID_OR_NUMBER]
v3_id1 (type: String.t) - Part of parent. See documentation of v3Id.
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").
- :serviceId (type: String.t) - Optional. The Service id to use for this Service. If omitted, an id will be generated instead. Must match the pattern [a-z0-9-]+
- :body (type: GoogleApi.Monitoring.V3.Model.Service.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Monitoring.V3.Model.Service{}} on success
{:error, info} on failure

monitoring_services_delete(connection, v3_id, v3_id1, services_id, optional_params \\ [], opts \\ [])

@spec monitoring_services_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Monitoring.V3.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Soft delete this Service.

Parameters

connection (type: GoogleApi.Monitoring.V3.Connection.t) - Connection to server
v3_id (type: String.t) - Part of name. Required. Resource name of the Service to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
v3_id1 (type: String.t) - Part of name. See documentation of v3Id.
services_id (type: String.t) - Part of name. See documentation of v3Id.
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.Monitoring.V3.Model.Empty{}} on success
{:error, info} on failure

monitoring_services_get(connection, v3_id, v3_id1, services_id, optional_params \\ [], opts \\ [])

@spec monitoring_services_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Monitoring.V3.Model.Service.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get the named Service.

Parameters

connection (type: GoogleApi.Monitoring.V3.Connection.t) - Connection to server
v3_id (type: String.t) - Part of name. Required. Resource name of the Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
v3_id1 (type: String.t) - Part of name. See documentation of v3Id.
services_id (type: String.t) - Part of name. See documentation of v3Id.
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.Monitoring.V3.Model.Service{}} on success
{:error, info} on failure

monitoring_services_list(connection, v3_id, v3_id1, optional_params \\ [], opts \\ [])

@spec monitoring_services_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Monitoring.V3.Model.ListServicesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List Services for this Metrics Scope.

Parameters

connection (type: GoogleApi.Monitoring.V3.Connection.t) - Connection to server
v3_id (type: String.t) - Part of parent. Required. Resource name of the parent containing the listed services, either a project (https://cloud.google.com/monitoring/api/v3#project_name) or a Monitoring Metrics Scope. The formats are: projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_PROJECT_ID_OR_NUMBER]
v3_id1 (type: String.t) - Part of parent. See documentation of v3Id.
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) - A filter specifying what Services to return. The filter supports filtering on a particular service-identifier type or one of its attributes.To filter on a particular service-identifier type, the identifier_case refers to which option in the identifier field is populated. For example, the filter identifier_case = "CUSTOM" would match all services with a value for the custom field. Valid options include "CUSTOM", "APP_ENGINE", "MESH_ISTIO", and the other options listed at https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#ServiceTo filter on an attribute of a service-identifier type, apply the filter name by using the snake case of the service-identifier type and the attribute of that service-identifier type, and join the two with a period. For example, to filter by the meshUid field of the MeshIstio service-identifier type, you must filter on mesh_istio.mesh_uid = "123" to match all services with mesh UID "123". Service-identifier types and their attributes are described at https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service
- :pageSize (type: integer()) - A non-negative number that is the maximum number of results to return. When 0, use default page size.
- :pageToken (type: String.t) - If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Monitoring.V3.Model.ListServicesResponse{}} on success
{:error, info} on failure

monitoring_services_patch(connection, v3_id, v3_id1, services_id, optional_params \\ [], opts \\ [])

@spec monitoring_services_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Monitoring.V3.Model.Service.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Update this Service.

Parameters

connection (type: GoogleApi.Monitoring.V3.Connection.t) - Connection to server
v3_id (type: String.t) - Part of service.name. Identifier. Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
v3_id1 (type: String.t) - Part of service.name. See documentation of v3Id.
services_id (type: String.t) - Part of service.name. See documentation of v3Id.
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").
- :updateMask (type: String.t) - A set of field paths defining which fields to use for the update.
- :body (type: GoogleApi.Monitoring.V3.Model.Service.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Monitoring.V3.Model.Service{}} on success
{:error, info} on failure

monitoring_services_service_level_objectives_create(connection, v3_id, v3_id1, services_id, optional_params \\ [], opts \\ [])

@spec monitoring_services_service_level_objectives_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Monitoring.V3.Model.ServiceLevelObjective.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Create a ServiceLevelObjective for the given Service.

Parameters

connection (type: GoogleApi.Monitoring.V3.Connection.t) - Connection to server
v3_id (type: String.t) - Part of parent. Required. Resource name of the parent Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
v3_id1 (type: String.t) - Part of parent. See documentation of v3Id.
services_id (type: String.t) - Part of parent. See documentation of v3Id.
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").
- :serviceLevelObjectiveId (type: String.t) - Optional. The ServiceLevelObjective id to use for this ServiceLevelObjective. If omitted, an id will be generated instead. Must match the pattern ^[a-zA-Z0-9-_:.]+$
- :body (type: GoogleApi.Monitoring.V3.Model.ServiceLevelObjective.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Monitoring.V3.Model.ServiceLevelObjective{}} on success
{:error, info} on failure

monitoring_services_service_level_objectives_delete(connection, v3_id, v3_id1, services_id, service_level_objectives_id, optional_params \\ [], opts \\ [])

@spec monitoring_services_service_level_objectives_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Monitoring.V3.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Delete the given ServiceLevelObjective.

Parameters

connection (type: GoogleApi.Monitoring.V3.Connection.t) - Connection to server
v3_id (type: String.t) - Part of name. Required. Resource name of the ServiceLevelObjective to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
v3_id1 (type: String.t) - Part of name. See documentation of v3Id.
services_id (type: String.t) - Part of name. See documentation of v3Id.
service_level_objectives_id (type: String.t) - Part of name. See documentation of v3Id.
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.Monitoring.V3.Model.Empty{}} on success
{:error, info} on failure

monitoring_services_service_level_objectives_get(connection, v3_id, v3_id1, services_id, service_level_objectives_id, optional_params \\ [], opts \\ [])

@spec monitoring_services_service_level_objectives_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Monitoring.V3.Model.ServiceLevelObjective.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get a ServiceLevelObjective by name.

Parameters

connection (type: GoogleApi.Monitoring.V3.Connection.t) - Connection to server
v3_id (type: String.t) - Part of name. Required. Resource name of the ServiceLevelObjective to get. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
v3_id1 (type: String.t) - Part of name. See documentation of v3Id.
services_id (type: String.t) - Part of name. See documentation of v3Id.
service_level_objectives_id (type: String.t) - Part of name. See documentation of v3Id.
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) - View of the ServiceLevelObjective to return. If DEFAULT, return the ServiceLevelObjective as originally defined. If EXPLICIT and the ServiceLevelObjective is defined in terms of a BasicSli, replace the BasicSli with a RequestBasedSli spelling out how the SLI is computed.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Monitoring.V3.Model.ServiceLevelObjective{}} on success
{:error, info} on failure

monitoring_services_service_level_objectives_list(connection, v3_id, v3_id1, services_id, optional_params \\ [], opts \\ [])

@spec monitoring_services_service_level_objectives_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Monitoring.V3.Model.ListServiceLevelObjectivesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List the ServiceLevelObjectives for the given Service.

Parameters

connection (type: GoogleApi.Monitoring.V3.Connection.t) - Connection to server
v3_id (type: String.t) - Part of parent. Required. Resource name of the parent containing the listed SLOs, either a project or a Monitoring Metrics Scope. The formats are: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] workspaces/[HOST_PROJECT_ID_OR_NUMBER]/services/-
v3_id1 (type: String.t) - Part of parent. See documentation of v3Id.
services_id (type: String.t) - Part of parent. See documentation of v3Id.
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) - A filter specifying what ServiceLevelObjectives to return.
- :pageSize (type: integer()) - A non-negative number that is the maximum number of results to return. When 0, use default page size.
- :pageToken (type: String.t) - If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
- :view (type: String.t) - View of the ServiceLevelObjectives to return. If DEFAULT, return each ServiceLevelObjective as originally defined. If EXPLICIT and the ServiceLevelObjective is defined in terms of a BasicSli, replace the BasicSli with a RequestBasedSli spelling out how the SLI is computed.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Monitoring.V3.Model.ListServiceLevelObjectivesResponse{}} on success
{:error, info} on failure

monitoring_services_service_level_objectives_patch(connection, v3_id, v3_id1, services_id, service_level_objectives_id, optional_params \\ [], opts \\ [])

@spec monitoring_services_service_level_objectives_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Monitoring.V3.Model.ServiceLevelObjective.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Update the given ServiceLevelObjective.

Parameters

connection (type: GoogleApi.Monitoring.V3.Connection.t) - Connection to server
v3_id (type: String.t) - Part of serviceLevelObjective.name. Identifier. Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
v3_id1 (type: String.t) - Part of serviceLevelObjective.name. See documentation of v3Id.
services_id (type: String.t) - Part of serviceLevelObjective.name. See documentation of v3Id.
service_level_objectives_id (type: String.t) - Part of serviceLevelObjective.name. See documentation of v3Id.
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").
- :updateMask (type: String.t) - A set of field paths defining which fields to use for the update.
- :body (type: GoogleApi.Monitoring.V3.Model.ServiceLevelObjective.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Monitoring.V3.Model.ServiceLevelObjective{}} on success
{:error, info} on failure