"""Generated message classes for iamconnectors version v1alpha.

"""
# NOTE: This file is autogenerated and should not be edited by hand.

from apitools.base.protorpclite import messages as _messages
from apitools.base.py import encoding
from apitools.base.py import extra_types


package = 'iamconnectors'


class AccessEvent(_messages.Message):
  r"""Message describing AccessEvent object

  Messages:
    LabelsValue: Optional. Labels as key value pairs

  Fields:
    connector: Output only. The connector that this access event is associated
      with.
    firstAccessTime: Output only. The first time this user has interacted with
      this agent. Rounded to the previous hour.
    labels: Optional. Labels as key value pairs
    lastAccessTime: Output only. The most recent time this user has interacted
      with this agent. Rounded to the previous hour.
    name: Output only. Identifier. Name of the AccessEvent
    purgeTime: Output only. The time when this access event is permanently
      deleted.
    scopes: Output only. All scopes that have been used by this user with this
      agent. The number of scopes is limited to 200.
    tokenEndpoint: Output only. The url of the authentication server that was
      accessed.
    userId: Output only. The user_id provided by the agent application for
      this user. Not verified by Google.
    workload: Output only. The identity bound to the workload that this user
      interacted with to produce this AccessEvent. Will typically be an
      agentic spiffe id
  """

  @encoding.MapUnrecognizedFields('additionalProperties')
  class LabelsValue(_messages.Message):
    r"""Optional. Labels as key value pairs

    Messages:
      AdditionalProperty: An additional property for a LabelsValue object.

    Fields:
      additionalProperties: Additional properties of type LabelsValue
    """

    class AdditionalProperty(_messages.Message):
      r"""An additional property for a LabelsValue object.

      Fields:
        key: Name of the additional property.
        value: A string attribute.
      """

      key = _messages.StringField(1)
      value = _messages.StringField(2)

    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)

  connector = _messages.StringField(1)
  firstAccessTime = _messages.StringField(2)
  labels = _messages.MessageField('LabelsValue', 3)
  lastAccessTime = _messages.StringField(4)
  name = _messages.StringField(5)
  purgeTime = _messages.StringField(6)
  scopes = _messages.StringField(7, repeated=True)
  tokenEndpoint = _messages.StringField(8)
  userId = _messages.StringField(9)
  workload = _messages.StringField(10)


class ApiKeyParams(_messages.Message):
  r"""Message describing ApiKeyParams object.

  Fields:
    apiKey: Optional. Input only. The API key for this connector.
  """

  apiKey = _messages.StringField(1)


class Authorization(_messages.Message):
  r"""Message describing Authorization object

  Enums:
    StateValueValuesEnum: Output only. The state of the authorization.

  Fields:
    clientUserId: Output only. The client_user_id provided by the client
      application for their end user. Not verified by Google.
    createTime: Output only. [Output only] Create time stamp
    name: Identifier. name of resource
    scopes: Output only. The scopes actually granted by the end user during
      the consent flow.
    state: Output only. The state of the authorization.
    updateTime: Output only. [Output only] Update time stamp
  """

  class StateValueValuesEnum(_messages.Enum):
    r"""Output only. The state of the authorization.

    Values:
      STATE_UNSPECIFIED: Unspecified state.
      ACTIVE: Active.
      SUSPENDED: Suspended.
    """
    STATE_UNSPECIFIED = 0
    ACTIVE = 1
    SUSPENDED = 2

  clientUserId = _messages.StringField(1)
  createTime = _messages.StringField(2)
  name = _messages.StringField(3)
  scopes = _messages.StringField(4, repeated=True)
  state = _messages.EnumField('StateValueValuesEnum', 5)
  updateTime = _messages.StringField(6)


class CancelOperationRequest(_messages.Message):
  r"""The request message for Operations.CancelOperation."""


class Connector(_messages.Message):
  r"""Message describing Connector object

  Enums:
    StateValueValuesEnum: Optional. The state of the connector.

  Messages:
    LabelsValue: Optional. Labels as key value pairs

  Fields:
    allowedScopes: Optional. List of scopes that are allowed to be requested
      for this connector. If this list is non-empty, only scopes within this
      list may be requested. If this list is empty, all scopes may be
      requested. Scopes appearing in `blocked_scopes` are disallowed even if
      they appear in `allowed_scopes`. The number of allowed scopes is limited
      to 200.
    blockedScopes: Optional. List of scopes that are blocked from being
      requested for this connector. If a scope appears in this list, it may
      not be requested, even if it also appears in `allowed_scopes`.
      `blocked_scopes` takes precedence over `allowed_scopes`. The number of
      blocked scopes is limited to 200.
    connectorTypeParams: Required. Connector type specific parameters.
    createTime: Output only. [Output only] Create time stamp
    deleted: Output only. This is set to true if the connector is deleted.
    description: Optional. Description of the resource. Must be less than 256
      characters.
    expireTime: Output only. The time when the connector will expire.
    labels: Optional. Labels as key value pairs
    name: Identifier. The full resource name of the connector. Format:
      projects/{project}/locations/{location}/connectors/{connector}
    state: Optional. The state of the connector.
    updateTime: Output only. [Output only] Update time stamp
    workloadIds: Optional. Input only. Workload identity (SPIFFE ID) of the
      agent.
  """

  class StateValueValuesEnum(_messages.Enum):
    r"""Optional. The state of the connector.

    Values:
      STATE_UNSPECIFIED: Unspecified state.
      ENABLED: Enabled and can be used.
      DISABLED: Disabled and cannot be used.
    """
    STATE_UNSPECIFIED = 0
    ENABLED = 1
    DISABLED = 2

  @encoding.MapUnrecognizedFields('additionalProperties')
  class LabelsValue(_messages.Message):
    r"""Optional. Labels as key value pairs

    Messages:
      AdditionalProperty: An additional property for a LabelsValue object.

    Fields:
      additionalProperties: Additional properties of type LabelsValue
    """

    class AdditionalProperty(_messages.Message):
      r"""An additional property for a LabelsValue object.

      Fields:
        key: Name of the additional property.
        value: A string attribute.
      """

      key = _messages.StringField(1)
      value = _messages.StringField(2)

    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)

  allowedScopes = _messages.StringField(1, repeated=True)
  blockedScopes = _messages.StringField(2, repeated=True)
  connectorTypeParams = _messages.MessageField('ConnectorTypeParams', 3)
  createTime = _messages.StringField(4)
  deleted = _messages.BooleanField(5)
  description = _messages.StringField(6)
  expireTime = _messages.StringField(7)
  labels = _messages.MessageField('LabelsValue', 8)
  name = _messages.StringField(9)
  state = _messages.EnumField('StateValueValuesEnum', 10)
  updateTime = _messages.StringField(11)
  workloadIds = _messages.StringField(12, repeated=True)


class ConnectorTypeParams(_messages.Message):
  r"""Connector type specific parameters. Required when creating a connector.

  Fields:
    apiKey: ApiKey connector type parameters.
    geConnectorParams: GeminiEnterprise connector type parameters.
    threeLeggedOauth: ThreeLeggedOAuth connector type parameters.
    twoLeggedOauth: TwoLeggedOAuth connector type parameters.
  """

  apiKey = _messages.MessageField('ApiKeyParams', 1)
  geConnectorParams = _messages.MessageField('GeminiEnterpriseConnectorParams', 2)
  threeLeggedOauth = _messages.MessageField('ThreeLeggedOAuth', 3)
  twoLeggedOauth = _messages.MessageField('TwoLeggedOAuth', 4)


class Empty(_messages.Message):
  r"""A generic empty message that you can re-use to avoid defining duplicated
  empty messages in your APIs. A typical example is to use it as the request
  or the response type of an API method. For instance: service Foo { rpc
  Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
  """



class GeminiEnterpriseConnectorParams(_messages.Message):
  r"""Message describing GeminiEnterpriseConnectorParams object."""


class IamconnectorsProjectsLocationsAccessEventsGetRequest(_messages.Message):
  r"""A IamconnectorsProjectsLocationsAccessEventsGetRequest object.

  Fields:
    name: Required. Name of the resource
  """

  name = _messages.StringField(1, required=True)


class IamconnectorsProjectsLocationsAccessEventsListRequest(_messages.Message):
  r"""A IamconnectorsProjectsLocationsAccessEventsListRequest object.

  Fields:
    filter: Optional. Filter string to restrict the results. Currently
      supports filtering by `workload_id` only. Format: `workload_id=""`
    orderBy: Optional. Hint for how to order the results. Currently strictly
      ordered by time descending.
    pageSize: Optional. Requested page size. Server may return fewer items
      than requested. If unspecified, server will pick an appropriate default.
    pageToken: Optional. A token identifying a page of results the server
      should return.
    parent: Required. The parent resource where the search is performed.
      Format: projects/{project}/locations/{location}
  """

  filter = _messages.StringField(1)
  orderBy = _messages.StringField(2)
  pageSize = _messages.IntegerField(3, variant=_messages.Variant.INT32)
  pageToken = _messages.StringField(4)
  parent = _messages.StringField(5, required=True)


class IamconnectorsProjectsLocationsConnectorsAuthorizationsDeleteRequest(_messages.Message):
  r"""A IamconnectorsProjectsLocationsConnectorsAuthorizationsDeleteRequest
  object.

  Fields:
    name: Required. The name of the Authorization to delete. Format: projects/
      {project}/locations/{location}/connectors/{connector}/authorizations/{au
      thorization}
    requestId: Optional. 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. The
      server will guarantee that for at least 60 minutes after the first
      request. 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).
  """

  name = _messages.StringField(1, required=True)
  requestId = _messages.StringField(2)


class IamconnectorsProjectsLocationsConnectorsAuthorizationsGetRequest(_messages.Message):
  r"""A IamconnectorsProjectsLocationsConnectorsAuthorizationsGetRequest
  object.

  Fields:
    name: Required. Name of the resource
  """

  name = _messages.StringField(1, required=True)


class IamconnectorsProjectsLocationsConnectorsAuthorizationsListRequest(_messages.Message):
  r"""A IamconnectorsProjectsLocationsConnectorsAuthorizationsListRequest
  object.

  Fields:
    filter: Optional. Filter string to restrict the results. Currently
      supports filtering by `client_user_id` only. Format: `client_user_id=""`
    orderBy: Optional. Hint for how to order the results. Currently strictly
      ordered by time descending and cannot be changed.
    pageSize: Optional. Requested page size. Server may return fewer items
      than requested. If unspecified, server will pick an appropriate default.
    pageToken: Optional. A page token, received from a previous
      `ListAuthorizations` call. Provide this to retrieve the subsequent page.
      When paginating, all other parameters provided to `ListAuthorizations`
      must match the call that provided the page token.
    parent: Required. The parent resource where the search is performed.
      Format: projects/{project}/locations/{location}/connectors/{connector}
  """

  filter = _messages.StringField(1)
  orderBy = _messages.StringField(2)
  pageSize = _messages.IntegerField(3, variant=_messages.Variant.INT32)
  pageToken = _messages.StringField(4)
  parent = _messages.StringField(5, required=True)


class IamconnectorsProjectsLocationsConnectorsCreateRequest(_messages.Message):
  r"""A IamconnectorsProjectsLocationsConnectorsCreateRequest object.

  Fields:
    connector: A Connector resource to be passed as the request body.
    connectorId: Required. The ID to use for the connector, which will become
      the final segment of the connector's resource name. This value should be
      1-63 characters, and valid characters are /a-z-/. The first character
      must be a lowercase letter, and the last character must be a lowercase
      letter or a number.
    parent: Required. The parent resource where the connector is created.
      Format: projects/{project}/locations/{location}
    requestId: Optional. 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. The
      server will guarantee that for at least 60 minutes since the first
      request. 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).
  """

  connector = _messages.MessageField('Connector', 1)
  connectorId = _messages.StringField(2)
  parent = _messages.StringField(3, required=True)
  requestId = _messages.StringField(4)


class IamconnectorsProjectsLocationsConnectorsDeleteRequest(_messages.Message):
  r"""A IamconnectorsProjectsLocationsConnectorsDeleteRequest object.

  Fields:
    name: Required. Name of the resource
    requestId: Optional. 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. The
      server will guarantee that for at least 60 minutes after the first
      request. 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).
  """

  name = _messages.StringField(1, required=True)
  requestId = _messages.StringField(2)


class IamconnectorsProjectsLocationsConnectorsGetRequest(_messages.Message):
  r"""A IamconnectorsProjectsLocationsConnectorsGetRequest object.

  Fields:
    name: Required. Name of the resource
  """

  name = _messages.StringField(1, required=True)


class IamconnectorsProjectsLocationsConnectorsListRequest(_messages.Message):
  r"""A IamconnectorsProjectsLocationsConnectorsListRequest object.

  Fields:
    filter: Optional. Filter results. This field is currently ignored.
    orderBy: Optional. Hint for how to order the results. This field is
      currently ignored.
    pageSize: Optional. Requested page size. Server may return fewer items
      than requested. If unspecified, server will pick an appropriate default.
    pageToken: Optional. A token, which can be sent as `page_token` to
      retrieve the next page. If this field is omitted, the first page is
      returned.
    parent: Required. The parent resource where the search is performed.
      Format: projects/{project}/locations/{location}
    showDeleted: Optional. Deleted connectors will be kept with a soft-delete
      for 30 days before being purged. If this field is set to true, deleted
      connectors will also be returned.
  """

  filter = _messages.StringField(1)
  orderBy = _messages.StringField(2)
  pageSize = _messages.IntegerField(3, variant=_messages.Variant.INT32)
  pageToken = _messages.StringField(4)
  parent = _messages.StringField(5, required=True)
  showDeleted = _messages.BooleanField(6)


class IamconnectorsProjectsLocationsConnectorsPatchRequest(_messages.Message):
  r"""A IamconnectorsProjectsLocationsConnectorsPatchRequest object.

  Fields:
    connector: A Connector resource to be passed as the request body.
    name: Identifier. The full resource name of the connector. Format:
      projects/{project}/locations/{location}/connectors/{connector}
    requestId: Optional. 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. The
      server will guarantee that for at least 60 minutes since the first
      request. 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).
    updateMask: Optional. Field mask is used to specify the fields to be
      overwritten in the Connector resource by the update. The fields
      specified in the update_mask are relative to the resource, not the full
      request. A field will be overwritten if it is in the mask. If the user
      does not provide a mask then all fields present in the request will be
      overwritten.
  """

  connector = _messages.MessageField('Connector', 1)
  name = _messages.StringField(2, required=True)
  requestId = _messages.StringField(3)
  updateMask = _messages.StringField(4)


class IamconnectorsProjectsLocationsConnectorsQueryRequest(_messages.Message):
  r"""A IamconnectorsProjectsLocationsConnectorsQueryRequest object.

  Fields:
    pageSize: Optional. Requested page size. Server may return fewer items
      than requested. If unspecified, server will pick an appropriate default.
      The maximum page size is 1000.
    pageToken: Optional. A token, which can be sent as `page_token` to
      retrieve the next page. If this field is omitted, the first page is
      returned. A page token, received from a previous QueryConnectors call.
      Provide this to retrieve the subsequent page. When paginating, all other
      parameters provided to QueryConnectors must match the call that provided
      the page token.
    parent: Required. The parent resource where the search is performed.
      Format: projects/{project}/locations/{location}
    workloadId: Required. The workload identifier to filter by.
  """

  pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32)
  pageToken = _messages.StringField(2)
  parent = _messages.StringField(3, required=True)
  workloadId = _messages.StringField(4)


class IamconnectorsProjectsLocationsConnectorsQueryWorkloadsRequest(_messages.Message):
  r"""A IamconnectorsProjectsLocationsConnectorsQueryWorkloadsRequest object.

  Fields:
    name: Required. The name of the connector to query. Format:
      projects/{project}/locations/{location}/connectors/{connector}
    pageSize: Optional. Requested page size. Server may return fewer items
      than requested. If unspecified, server will pick an appropriate default.
    pageToken: Optional. A token, which can be sent as `page_token` to
      retrieve the next page. When paginating, all other parameters provided
      to QueryWorkloads must match the call that provided the page token. If
      this field is omitted, the first page is returned.
  """

  name = _messages.StringField(1, required=True)
  pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32)
  pageToken = _messages.StringField(3)


class IamconnectorsProjectsLocationsConnectorsRevokeAuthorizationRequest(_messages.Message):
  r"""A IamconnectorsProjectsLocationsConnectorsRevokeAuthorizationRequest
  object.

  Fields:
    name: Required. The resource name of the Connector. Format:
      projects/{project}/locations/{location}/connectors/{connector}
    revokeAuthorizationRequest: A RevokeAuthorizationRequest resource to be
      passed as the request body.
  """

  name = _messages.StringField(1, required=True)
  revokeAuthorizationRequest = _messages.MessageField('RevokeAuthorizationRequest', 2)


class IamconnectorsProjectsLocationsConnectorsUndeleteRequest(_messages.Message):
  r"""A IamconnectorsProjectsLocationsConnectorsUndeleteRequest object.

  Fields:
    name: Required. Name of the resource Format:
      projects/{project}/locations/{location}/connectors/{connector}
    undeleteConnectorRequest: A UndeleteConnectorRequest resource to be passed
      as the request body.
  """

  name = _messages.StringField(1, required=True)
  undeleteConnectorRequest = _messages.MessageField('UndeleteConnectorRequest', 2)


class IamconnectorsProjectsLocationsGetRequest(_messages.Message):
  r"""A IamconnectorsProjectsLocationsGetRequest object.

  Fields:
    name: Resource name for the location.
  """

  name = _messages.StringField(1, required=True)


class IamconnectorsProjectsLocationsListRequest(_messages.Message):
  r"""A IamconnectorsProjectsLocationsListRequest object.

  Fields:
    extraLocationTypes: Optional. Do not use this field. It is unsupported and
      is ignored unless explicitly documented otherwise. This is primarily for
      internal usage.
    filter: A filter to narrow down results to a preferred subset. The
      filtering language accepts strings like `"displayName=tokyo"`, and is
      documented in more detail in [AIP-160](https://google.aip.dev/160).
    name: The resource that owns the locations collection, if applicable.
    pageSize: The maximum number of results to return. If not set, the service
      selects a default.
    pageToken: A page token received from the `next_page_token` field in the
      response. Send that page token to receive the subsequent page.
  """

  extraLocationTypes = _messages.StringField(1, repeated=True)
  filter = _messages.StringField(2)
  name = _messages.StringField(3, required=True)
  pageSize = _messages.IntegerField(4, variant=_messages.Variant.INT32)
  pageToken = _messages.StringField(5)


class IamconnectorsProjectsLocationsOperationsCancelRequest(_messages.Message):
  r"""A IamconnectorsProjectsLocationsOperationsCancelRequest object.

  Fields:
    cancelOperationRequest: A CancelOperationRequest resource to be passed as
      the request body.
    name: The name of the operation resource to be cancelled.
  """

  cancelOperationRequest = _messages.MessageField('CancelOperationRequest', 1)
  name = _messages.StringField(2, required=True)


class IamconnectorsProjectsLocationsOperationsDeleteRequest(_messages.Message):
  r"""A IamconnectorsProjectsLocationsOperationsDeleteRequest object.

  Fields:
    name: The name of the operation resource to be deleted.
  """

  name = _messages.StringField(1, required=True)


class IamconnectorsProjectsLocationsOperationsGetRequest(_messages.Message):
  r"""A IamconnectorsProjectsLocationsOperationsGetRequest object.

  Fields:
    name: The name of the operation resource.
  """

  name = _messages.StringField(1, required=True)


class IamconnectorsProjectsLocationsOperationsListRequest(_messages.Message):
  r"""A IamconnectorsProjectsLocationsOperationsListRequest object.

  Fields:
    filter: The standard list filter.
    name: The name of the operation's parent resource.
    pageSize: The standard list page size.
    pageToken: The standard list page token.
    returnPartialSuccess: When set to `true`, operations that are reachable
      are returned as normal, and those that are unreachable are returned in
      the ListOperationsResponse.unreachable field. This can only be `true`
      when reading across collections. For example, when `parent` is set to
      `"projects/example/locations/-"`. This field is not supported by default
      and will result in an `UNIMPLEMENTED` error if set unless explicitly
      documented otherwise in service or product specific documentation.
  """

  filter = _messages.StringField(1)
  name = _messages.StringField(2, required=True)
  pageSize = _messages.IntegerField(3, variant=_messages.Variant.INT32)
  pageToken = _messages.StringField(4)
  returnPartialSuccess = _messages.BooleanField(5)


class ListAccessEventsResponse(_messages.Message):
  r"""Message for response to listing AccessEvents

  Fields:
    accessEvents: The list of AccessEvent
    nextPageToken: A token identifying a page of results the server should
      return.
    unreachable: Unordered list. Locations that could not be reached.
  """

  accessEvents = _messages.MessageField('AccessEvent', 1, repeated=True)
  nextPageToken = _messages.StringField(2)
  unreachable = _messages.StringField(3, repeated=True)


class ListAuthorizationsResponse(_messages.Message):
  r"""Message for response to listing Authorizations

  Fields:
    authorizations: The list of Authorization
    nextPageToken: A token identifying a page of results the server should
      return.
    unreachable: Unordered list. Locations that could not be reached.
  """

  authorizations = _messages.MessageField('Authorization', 1, repeated=True)
  nextPageToken = _messages.StringField(2)
  unreachable = _messages.StringField(3, repeated=True)


class ListConnectorsResponse(_messages.Message):
  r"""Message for response to listing Connectors

  Fields:
    connectors: The list of Connector
    nextPageToken: A token identifying a page of results the server should
      return.
    unreachable: Unordered list. Locations that could not be reached.
  """

  connectors = _messages.MessageField('Connector', 1, repeated=True)
  nextPageToken = _messages.StringField(2)
  unreachable = _messages.StringField(3, repeated=True)


class ListLocationsResponse(_messages.Message):
  r"""The response message for Locations.ListLocations.

  Fields:
    locations: A list of locations that matches the specified filter in the
      request.
    nextPageToken: The standard List next-page token.
  """

  locations = _messages.MessageField('Location', 1, repeated=True)
  nextPageToken = _messages.StringField(2)


class ListOperationsResponse(_messages.Message):
  r"""The response message for Operations.ListOperations.

  Fields:
    nextPageToken: The standard List next-page token.
    operations: A list of operations that matches the specified filter in the
      request.
    unreachable: Unordered list. Unreachable resources. Populated when the
      request sets `ListOperationsRequest.return_partial_success` and reads
      across collections. For example, when attempting to list all resources
      across all supported locations.
  """

  nextPageToken = _messages.StringField(1)
  operations = _messages.MessageField('Operation', 2, repeated=True)
  unreachable = _messages.StringField(3, repeated=True)


class Location(_messages.Message):
  r"""A resource that represents a Google Cloud location.

  Messages:
    LabelsValue: Cross-service attributes for the location. For example
      {"cloud.googleapis.com/region": "us-east1"}
    MetadataValue: Service-specific metadata. For example the available
      capacity at the given location.

  Fields:
    displayName: The friendly name for this location, typically a nearby city
      name. For example, "Tokyo".
    labels: Cross-service attributes for the location. For example
      {"cloud.googleapis.com/region": "us-east1"}
    locationId: The canonical id for this location. For example: `"us-east1"`.
    metadata: Service-specific metadata. For example the available capacity at
      the given location.
    name: Resource name for the location, which may vary between
      implementations. For example: `"projects/example-project/locations/us-
      east1"`
  """

  @encoding.MapUnrecognizedFields('additionalProperties')
  class LabelsValue(_messages.Message):
    r"""Cross-service attributes for the location. For example
    {"cloud.googleapis.com/region": "us-east1"}

    Messages:
      AdditionalProperty: An additional property for a LabelsValue object.

    Fields:
      additionalProperties: Additional properties of type LabelsValue
    """

    class AdditionalProperty(_messages.Message):
      r"""An additional property for a LabelsValue object.

      Fields:
        key: Name of the additional property.
        value: A string attribute.
      """

      key = _messages.StringField(1)
      value = _messages.StringField(2)

    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)

  @encoding.MapUnrecognizedFields('additionalProperties')
  class MetadataValue(_messages.Message):
    r"""Service-specific metadata. For example the available capacity at the
    given location.

    Messages:
      AdditionalProperty: An additional property for a MetadataValue object.

    Fields:
      additionalProperties: Properties of the object. Contains field @type
        with type URL.
    """

    class AdditionalProperty(_messages.Message):
      r"""An additional property for a MetadataValue object.

      Fields:
        key: Name of the additional property.
        value: A extra_types.JsonValue attribute.
      """

      key = _messages.StringField(1)
      value = _messages.MessageField('extra_types.JsonValue', 2)

    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)

  displayName = _messages.StringField(1)
  labels = _messages.MessageField('LabelsValue', 2)
  locationId = _messages.StringField(3)
  metadata = _messages.MessageField('MetadataValue', 4)
  name = _messages.StringField(5)


class Operation(_messages.Message):
  r"""This resource represents a long-running operation that is the result of
  a network API call.

  Messages:
    MetadataValue: Service-specific metadata associated with the operation. It
      typically contains progress information and common metadata such as
      create time. Some services might not provide such metadata. Any method
      that returns a long-running operation should document the metadata type,
      if any.
    ResponseValue: The normal, successful response of the operation. If the
      original method returns no data on success, such as `Delete`, the
      response is `google.protobuf.Empty`. If the original method is standard
      `Get`/`Create`/`Update`, the response should be the resource. For other
      methods, the response should have the type `XxxResponse`, where `Xxx` is
      the original method name. For example, if the original method name is
      `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

  Fields:
    done: If the value is `false`, it means the operation is still in
      progress. If `true`, the operation is completed, and either `error` or
      `response` is available.
    error: The error result of the operation in case of failure or
      cancellation.
    metadata: Service-specific metadata associated with the operation. It
      typically contains progress information and common metadata such as
      create time. Some services might not provide such metadata. Any method
      that returns a long-running operation should document the metadata type,
      if any.
    name: The server-assigned name, which is only unique within the same
      service that originally returns it. If you use the default HTTP mapping,
      the `name` should be a resource name ending with
      `operations/{unique_id}`.
    response: The normal, successful response of the operation. If the
      original method returns no data on success, such as `Delete`, the
      response is `google.protobuf.Empty`. If the original method is standard
      `Get`/`Create`/`Update`, the response should be the resource. For other
      methods, the response should have the type `XxxResponse`, where `Xxx` is
      the original method name. For example, if the original method name is
      `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
  """

  @encoding.MapUnrecognizedFields('additionalProperties')
  class MetadataValue(_messages.Message):
    r"""Service-specific metadata associated with the operation. It typically
    contains progress information and common metadata such as create time.
    Some services might not provide such metadata. Any method that returns a
    long-running operation should document the metadata type, if any.

    Messages:
      AdditionalProperty: An additional property for a MetadataValue object.

    Fields:
      additionalProperties: Properties of the object. Contains field @type
        with type URL.
    """

    class AdditionalProperty(_messages.Message):
      r"""An additional property for a MetadataValue object.

      Fields:
        key: Name of the additional property.
        value: A extra_types.JsonValue attribute.
      """

      key = _messages.StringField(1)
      value = _messages.MessageField('extra_types.JsonValue', 2)

    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)

  @encoding.MapUnrecognizedFields('additionalProperties')
  class ResponseValue(_messages.Message):
    r"""The normal, successful response of the operation. If the original
    method returns no data on success, such as `Delete`, the response is
    `google.protobuf.Empty`. If the original method is standard
    `Get`/`Create`/`Update`, the response should be the resource. For other
    methods, the response should have the type `XxxResponse`, where `Xxx` is
    the original method name. For example, if the original method name is
    `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

    Messages:
      AdditionalProperty: An additional property for a ResponseValue object.

    Fields:
      additionalProperties: Properties of the object. Contains field @type
        with type URL.
    """

    class AdditionalProperty(_messages.Message):
      r"""An additional property for a ResponseValue object.

      Fields:
        key: Name of the additional property.
        value: A extra_types.JsonValue attribute.
      """

      key = _messages.StringField(1)
      value = _messages.MessageField('extra_types.JsonValue', 2)

    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)

  done = _messages.BooleanField(1)
  error = _messages.MessageField('Status', 2)
  metadata = _messages.MessageField('MetadataValue', 3)
  name = _messages.StringField(4)
  response = _messages.MessageField('ResponseValue', 5)


class OperationMetadata(_messages.Message):
  r"""Represents the metadata of the long-running operation.

  Fields:
    apiVersion: Output only. API version used to start the operation.
    createTime: Output only. The time the operation was created.
    endTime: Output only. The time the operation finished running.
    requestedCancellation: Output only. Identifies whether the user has
      requested cancellation of the operation. Operations that have been
      cancelled successfully have google.longrunning.Operation.error value
      with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
    statusMessage: Output only. Human-readable status of the operation, if
      any.
    target: Output only. Server-defined resource path for the target of the
      operation.
    verb: Output only. Name of the verb executed by the operation.
  """

  apiVersion = _messages.StringField(1)
  createTime = _messages.StringField(2)
  endTime = _messages.StringField(3)
  requestedCancellation = _messages.BooleanField(4)
  statusMessage = _messages.StringField(5)
  target = _messages.StringField(6)
  verb = _messages.StringField(7)


class QueryConnectorsResponse(_messages.Message):
  r"""Response message for QueryConnectors.

  Fields:
    connectorNames: The unique list of connector resource names used by the
      workload.
    nextPageToken: A token identifying a page of results the server should
      return. If this field is omitted, there are no subsequent pages.
  """

  connectorNames = _messages.StringField(1, repeated=True)
  nextPageToken = _messages.StringField(2)


class QueryWorkloadsResponse(_messages.Message):
  r"""Response message for QueryWorkloads.

  Fields:
    nextPageToken: A token to retrieve the next page of results.
    workloadIds: The unique list of workload identifiers (agents) that used
      the connector.
  """

  nextPageToken = _messages.StringField(1)
  workloadIds = _messages.StringField(2, repeated=True)


class RevokeAuthorizationRequest(_messages.Message):
  r"""Request message for RevokeAuthorization.

  Fields:
    userId: Required. The identity of the user to revoke authorization for.
  """

  userId = _messages.StringField(1)


class RevokeAuthorizationResponse(_messages.Message):
  r"""Response message for RevokeAuthorization."""


class StandardQueryParameters(_messages.Message):
  r"""Query parameters accepted by all methods.

  Enums:
    FXgafvValueValuesEnum: V1 error format.
    AltValueValuesEnum: Data format for response.

  Fields:
    f__xgafv: V1 error format.
    access_token: OAuth access token.
    alt: Data format for response.
    callback: JSONP
    fields: Selector specifying which fields to include in a partial response.
    key: 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: OAuth 2.0 token for the current user.
    prettyPrint: Returns response with indentations and line breaks.
    quotaUser: 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.
    trace: A tracing token of the form "token:<tokenid>" to include in api
      requests.
    uploadType: Legacy upload protocol for media (e.g. "media", "multipart").
    upload_protocol: Upload protocol for media (e.g. "raw", "multipart").
  """

  class AltValueValuesEnum(_messages.Enum):
    r"""Data format for response.

    Values:
      json: Responses with Content-Type of application/json
      media: Media download with context-dependent Content-Type
      proto: Responses with Content-Type of application/x-protobuf
    """
    json = 0
    media = 1
    proto = 2

  class FXgafvValueValuesEnum(_messages.Enum):
    r"""V1 error format.

    Values:
      _1: v1 error format
      _2: v2 error format
    """
    _1 = 0
    _2 = 1

  f__xgafv = _messages.EnumField('FXgafvValueValuesEnum', 1)
  access_token = _messages.StringField(2)
  alt = _messages.EnumField('AltValueValuesEnum', 3, default='json')
  callback = _messages.StringField(4)
  fields = _messages.StringField(5)
  key = _messages.StringField(6)
  oauth_token = _messages.StringField(7)
  prettyPrint = _messages.BooleanField(8, default=True)
  quotaUser = _messages.StringField(9)
  trace = _messages.StringField(10)
  uploadType = _messages.StringField(11)
  upload_protocol = _messages.StringField(12)


class Status(_messages.Message):
  r"""The `Status` type defines a logical error model that is suitable for
  different programming environments, including REST APIs and RPC APIs. It is
  used by [gRPC](https://github.com/grpc). Each `Status` message contains
  three pieces of data: error code, error message, and error details. You can
  find out more about this error model and how to work with it in the [API
  Design Guide](https://cloud.google.com/apis/design/errors).

  Messages:
    DetailsValueListEntry: A DetailsValueListEntry object.

  Fields:
    code: The status code, which should be an enum value of google.rpc.Code.
    details: A list of messages that carry the error details. There is a
      common set of message types for APIs to use.
    message: A developer-facing error message, which should be in English. Any
      user-facing error message should be localized and sent in the
      google.rpc.Status.details field, or localized by the client.
  """

  @encoding.MapUnrecognizedFields('additionalProperties')
  class DetailsValueListEntry(_messages.Message):
    r"""A DetailsValueListEntry object.

    Messages:
      AdditionalProperty: An additional property for a DetailsValueListEntry
        object.

    Fields:
      additionalProperties: Properties of the object. Contains field @type
        with type URL.
    """

    class AdditionalProperty(_messages.Message):
      r"""An additional property for a DetailsValueListEntry object.

      Fields:
        key: Name of the additional property.
        value: A extra_types.JsonValue attribute.
      """

      key = _messages.StringField(1)
      value = _messages.MessageField('extra_types.JsonValue', 2)

    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)

  code = _messages.IntegerField(1, variant=_messages.Variant.INT32)
  details = _messages.MessageField('DetailsValueListEntry', 2, repeated=True)
  message = _messages.StringField(3)


class ThreeLeggedOAuth(_messages.Message):
  r"""Message describing ThreeLeggedOAuth object.

  Fields:
    authorizationUrl: Optional. The authorization endpoint to send users to
      for consenting to delegate to the agent. eg.
      "https://auth.atlassian.com/authorize"
    clientId: Optional. The client ID of the OAuth client.
    clientSecret: Optional. Input only. The client secret of the OAuth client.
    redirectUrl: Output only. The redirect URL this connector uses for the
      OAuth exchange. This is deterministic based on the name of the
      connector.
    tokenUrl: Optional. The token endpoint for requesting tokens on behalf of
      an end user. eg. "https://auth.atlassian.com/oauth/token"
  """

  authorizationUrl = _messages.StringField(1)
  clientId = _messages.StringField(2)
  clientSecret = _messages.StringField(3)
  redirectUrl = _messages.StringField(4)
  tokenUrl = _messages.StringField(5)


class TwoLeggedOAuth(_messages.Message):
  r"""Message describing TwoLeggedOAuth object.

  Fields:
    clientId: Optional. The client ID of the OAuth client.
    clientSecret: Optional. Input only. The client secret of the OAuth client.
    tokenEndpoint: Optional. The token endpoint of the OAuth client.
  """

  clientId = _messages.StringField(1)
  clientSecret = _messages.StringField(2)
  tokenEndpoint = _messages.StringField(3)


class UndeleteConnectorRequest(_messages.Message):
  r"""Message for undeleting a Connector

  Fields:
    requestId: Optional. 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. The
      server will guarantee that for at least 60 minutes after the first
      request. The request ID must be a valid UUID with the exception that
      zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  """

  requestId = _messages.StringField(1)


encoding.AddCustomJsonFieldMapping(
    StandardQueryParameters, 'f__xgafv', '$.xgafv')
encoding.AddCustomJsonEnumMapping(
    StandardQueryParameters.FXgafvValueValuesEnum, '_1', '1')
encoding.AddCustomJsonEnumMapping(
    StandardQueryParameters.FXgafvValueValuesEnum, '_2', '2')
