You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
kratos/third_party/google/cloud/irm/v1alpha2/irm_gapic.yaml

718 lines
20 KiB

type: com.google.api.codegen.ConfigProto
config_schema_version: 1.0.0
# The settings of generated code in a specific language.
language_settings:
java:
package_name: com.google.cloud.irm.v1alpha2
python:
package_name: google.cloud.irm_v1alpha2.gapic
go:
package_name: cloud.google.com/go/irm/apiv1alpha2
csharp:
package_name: Google.Cloud.Irm.V1Alpha2
ruby:
package_name: Google::Cloud::Irm::V1alpha2
php:
package_name: Google\Cloud\Irm\V1alpha2
nodejs:
package_name: irm.v1alpha2
domain_layer_location: google-cloud
# A list of API interface configurations.
interfaces:
# The fully qualified name of the API interface.
- name: google.cloud.irm.v1alpha2.IncidentService
# A list of resource collection configurations.
# Consists of a name_pattern and an entity_name.
# The name_pattern is a pattern to describe the names of the resources of this
# collection, using the platform's conventions for URI patterns. A generator
# may use this to generate methods to compose and decompose such names. The
# pattern should use named placeholders as in `shelves/{shelf}/books/{book}`;
# those will be taken as hints for the parameter names of the generated
# methods. If empty, no name methods are generated.
# The entity_name is the name to be used as a basis for generated methods and
# classes.
collections:
- name_pattern: projects/{project}
entity_name: project
language_overrides:
- language: csharp
common_resource_name: Google.Api.Gax.ResourceNames.ProjectName
- name_pattern: projects/{project}/incidents/{incident}
entity_name: incident
- name_pattern: projects/{project}/incidents/{incident}/annotations/{annotation}
entity_name: annotation
- name_pattern: projects/{project}/incidents/{incident}/artifacts/{artifact}
entity_name: artifact
- name_pattern: projects/{project}/incidents/{incident}/roleAssignments/{role_assignment}
entity_name: role_assignment
- name_pattern: projects/{project}/incidents/{incident}/subscriptions/{subscription}
entity_name: subscription
- name_pattern: projects/{project}/incidents/{incident}/tags/{tag}
entity_name: tag
- name_pattern: projects/{project}/signals/{signal}
entity_name: signal
# Definition for retryable codes.
retry_codes_def:
- name: idempotent
retry_codes:
- UNAVAILABLE
- name: non_idempotent
retry_codes: []
# Definition for retry/backoff parameters.
retry_params_def:
- name: default
initial_retry_delay_millis: 100
retry_delay_multiplier: 1.3
max_retry_delay_millis: 60000
initial_rpc_timeout_millis: 20000
rpc_timeout_multiplier: 1
max_rpc_timeout_millis: 20000
total_timeout_millis: 600000
# A list of method configurations.
# Common properties:
#
# name - The simple name of the method.
#
# flattening - Specifies the configuration for parameter flattening.
# Describes the parameter groups for which a generator should produce method
# overloads which allow a client to directly pass request message fields as
# method parameters. This information may or may not be used, depending on
# the target language.
# Consists of groups, which each represent a list of parameters to be
# flattened. Each parameter listed must be a field of the request message.
#
# required_fields - Fields that are always required for a request to be
# valid.
#
# resource_name_treatment - An enum that specifies how to treat the resource
# name formats defined in the field_name_patterns and
# response_field_name_patterns fields.
# UNSET: default value
# NONE: the collection configs will not be used by the generated code.
# VALIDATE: string fields will be validated by the client against the
# specified resource name formats.
# STATIC_TYPES: the client will use generated types for resource names.
#
# page_streaming - Specifies the configuration for paging.
# Describes information for generating a method which transforms a paging
# list RPC into a stream of resources.
# Consists of a request and a response.
# The request specifies request information of the list method. It defines
# which fields match the paging pattern in the request. The request consists
# of a page_size_field and a token_field. The page_size_field is the name of
# the optional field specifying the maximum number of elements to be
# returned in the response. The token_field is the name of the field in the
# request containing the page token.
# The response specifies response information of the list method. It defines
# which fields match the paging pattern in the response. The response
# consists of a token_field and a resources_field. The token_field is the
# name of the field in the response containing the next page token. The
# resources_field is the name of the field in the response containing the
# list of resources belonging to the page.
#
# retry_codes_name - Specifies the configuration for retryable codes. The
# name must be defined in interfaces.retry_codes_def.
#
# retry_params_name - Specifies the configuration for retry/backoff
# parameters. The name must be defined in interfaces.retry_params_def.
#
# field_name_patterns - Maps the field name of the request type to
# entity_name of interfaces.collections.
# Specifies the string pattern that the field must follow.
#
# timeout_millis - Specifies the default timeout for a non-retrying call. If
# the call is retrying, refer to retry_params_name instead.
methods:
- name: CreateIncident
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- incident
- parent
required_fields:
- incident
- parent
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: project
timeout_millis: 60000
- name: GetIncident
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- name
required_fields:
- name
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: incident
timeout_millis: 60000
- name: SearchIncidents
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- parent
- query
- time_zone
required_fields:
- parent
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: incidents
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: project
timeout_millis: 60000
- name: UpdateIncident
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- incident
- update_mask
required_fields:
- incident
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
incident.name: incident
timeout_millis: 60000
- name: SearchSimilarIncidents
flattening:
groups:
- parameters:
- name
required_fields:
- name
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: results
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: incident
timeout_millis: 60000
- name: CreateAnnotation
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- parent
- annotation
required_fields:
- parent
- annotation
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: incident
timeout_millis: 60000
- name: ListAnnotations
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- parent
required_fields:
- parent
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: annotations
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: incident
timeout_millis: 60000
- name: CreateTag
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- parent
- tag
required_fields:
- parent
- tag
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: incident
timeout_millis: 60000
- name: DeleteTag
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- name
required_fields:
- name
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: tag
timeout_millis: 60000
- name: ListTags
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- parent
required_fields:
- parent
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: tags
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: incident
timeout_millis: 60000
- name: CreateSignal
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- parent
- signal
required_fields:
- parent
- signal
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: project
timeout_millis: 60000
- name: SearchSignals
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- parent
- query
required_fields:
- parent
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: signals
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: project
timeout_millis: 60000
- name: GetSignal
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- name
required_fields:
- name
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: signal
timeout_millis: 60000
- name: UpdateSignal
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- signal
- update_mask
required_fields:
- signal
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
signal.name: signal
timeout_millis: 60000
- name: EscalateIncident
resource_name_treatment: STATIC_TYPES
required_fields:
- incident
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
incident.name: incident
timeout_millis: 60000
- name: CreateArtifact
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- parent
- artifact
required_fields:
- parent
- artifact
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: incident
timeout_millis: 60000
- name: ListArtifacts
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- parent
required_fields:
- parent
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: artifacts
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: incident
timeout_millis: 60000
- name: UpdateArtifact
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- artifact
- update_mask
required_fields:
- artifact
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
artifact.name: artifact
timeout_millis: 60000
- name: DeleteArtifact
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- name
required_fields:
- name
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: artifact
timeout_millis: 60000
- name: SendShiftHandoff
resource_name_treatment: STATIC_TYPES
required_fields:
- parent
- recipients
- subject
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: project
timeout_millis: 60000
- name: CreateSubscription
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- parent
- subscription
required_fields:
- parent
- subscription
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: incident
timeout_millis: 60000
- name: UpdateSubscription
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- subscription
- update_mask
required_fields:
- subscription
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
subscription.name: subscription
timeout_millis: 60000
- name: ListSubscriptions
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- parent
required_fields:
- parent
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: subscriptions
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: incident
timeout_millis: 60000
- name: DeleteSubscription
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- name
required_fields:
- name
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: subscription
timeout_millis: 60000
- name: CreateIncidentRoleAssignment
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- parent
- incident_role_assignment
required_fields:
- parent
- incident_role_assignment
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: incident
timeout_millis: 60000
- name: DeleteIncidentRoleAssignment
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- name
required_fields:
- name
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: role_assignment
timeout_millis: 60000
- name: ListIncidentRoleAssignments
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- parent
required_fields:
- parent
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: incident_role_assignments
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: incident
timeout_millis: 60000
- name: RequestIncidentRoleHandover
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- name
- new_assignee
required_fields:
- name
- new_assignee
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
name: role_assignment
timeout_millis: 60000
- name: ConfirmIncidentRoleHandover
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- name
- new_assignee
required_fields:
- name
- new_assignee
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
name: role_assignment
timeout_millis: 60000
- name: ForceIncidentRoleHandover
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- name
- new_assignee
required_fields:
- name
- new_assignee
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
name: role_assignment
timeout_millis: 60000
- name: CancelIncidentRoleHandover
resource_name_treatment: STATIC_TYPES
flattening:
groups:
- parameters:
- name
- new_assignee
required_fields:
- name
- new_assignee
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
name: role_assignment
timeout_millis: 60000
resource_name_generation:
- message_name: Annotation
field_entity_map:
name: annotation
- message_name: Artifact
field_entity_map:
name: artifact
- message_name: Incident
field_entity_map:
name: incident
- message_name: IncidentRoleAssignment
field_entity_map:
name: role_assignment
- message_name: Signal
field_entity_map:
name: signal
- message_name: Subscription
field_entity_map:
name: subscription
- message_name: Tag
field_entity_map:
name: tag
- message_name: CreateIncidentRequest
field_entity_map:
parent: project
- message_name: GetIncidentRequest
field_entity_map:
name: incident
- message_name: SearchIncidentsRequest
field_entity_map:
parent: project
- message_name: UpdateIncidentRequest
field_entity_map:
incident.name: incident
- message_name: EscalateIncidentRequest
field_entity_map:
incident.name: incident
- message_name: CreateSignalRequest
field_entity_map:
parent: project
- message_name: GetSignalRequest
field_entity_map:
name: signal
- message_name: SearchSignalsRequest
field_entity_map:
parent: project
- message_name: UpdateSignalRequest
field_entity_map:
signal.name: signal
- message_name: CreateArtifactRequest
field_entity_map:
parent: incident
- message_name: ListArtifactsRequest
field_entity_map:
parent: incident
- message_name: UpdateArtifactRequest
field_entity_map:
artifact.name: artifact
- message_name: DeleteArtifactRequest
field_entity_map:
name: artifact
- message_name: CreateIncidentRoleAssignmentRequest
field_entity_map:
parent: incident
- message_name: ListIncidentRoleAssignmentsRequest
field_entity_map:
parent: incident
- message_name: DeleteIncidentRoleAssignmentRequest
field_entity_map:
name: role_assignment
- message_name: RequestIncidentRoleHandoverRequest
field_entity_map:
name: role_assignment
- message_name: ConfirmIncidentRoleHandoverRequest
field_entity_map:
name: role_assignment
- message_name: ForceIncidentRoleHandoverRequest
field_entity_map:
name: role_assignment
- message_name: CancelIncidentRoleHandoverRequest
field_entity_map:
name: role_assignment
- message_name: CreateSubscriptionRequest
field_entity_map:
parent: incident
- message_name: ListSubscriptionsRequest
field_entity_map:
parent: incident
- message_name: UpdateSubscriptionRequest
field_entity_map:
subscription.name: subscription
- message_name: DeleteSubscriptionRequest
field_entity_map:
name: subscription
- message_name: CreateTagRequest
field_entity_map:
parent: incident
- message_name: ListTagsRequest
field_entity_map:
parent: incident
- message_name: DeleteTagRequest
field_entity_map:
name: tag
- message_name: CreateAnnotationRequest
field_entity_map:
parent: incident
- message_name: ListAnnotationsRequest
field_entity_map:
parent: incident
- message_name: SendShiftHandoffRequest
field_entity_map:
parent: project