google_api_apigee v0.2.0 API Reference

Modules

API calls for all endpoints tagged Hybrid.

API calls for all endpoints tagged Organizations.

Handle Tesla connections for GoogleApi.Apigee.V1.

Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page.

Attributes

  • Get (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AccessGet.t, default: nil) -
  • Remove (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AccessRemove.t, default: nil) -
  • Set (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AccessSet.t, default: nil) -

Get action. For example, "Get" : { "name" : "target.name", "value" : "default" }

Remove action. For example, "Remove" : { "name" : "target.name", "success" : true }

Set action. For example, "Set" : { "name" : "target.name", "success" : true, "value" : "default" }

A reference to a certificate or key, certificate pair.

Attributes

  • location (type: String.t, default: nil) - The location of the alias file, e.g. a GCS URI.
  • name (type: String.t, default: nil) - The name of the alias revision included in the keystore. Must be of the form: 'organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}/revisions/{rev}'.
  • type (type: String.t, default: nil) -

Attributes

  • analyticsScript (type: String.t, default: nil) - Details of the custom analytics script.
  • analyticsTrackingId (type: String.t, default: nil) - ID of the custom analytics script.

Attributes

  • message (type: String.t, default: nil) - Details of the announcement.

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AnnoucementData.t, default: nil) - Details of the announcement.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiDocBody.t, default: nil) - Details for the published API.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • anonAllowed (type: boolean(), default: nil) - Boolean flag that specifies whether all or only registered users can access the API.
  • apiId (type: String.t, default: nil) - ID of the API.
  • description (type: String.t, default: nil) - Description of the API.
  • edgeAPIProductName (type: String.t, default: nil) - Name of the associated API product.
  • enrollment (type: String.t, default: nil) - Not used by Apigee hybrid.
  • id (type: String.t, default: nil) - ID of the API.
  • imageUrl (type: String.t, default: nil) - URL of the image used for the API in the API catalog.
  • modified (type: String.t, default: nil) - Time the API was last modified in milliseconds since epoch.
  • productExists (type: boolean(), default: nil) - Boolean flag that specifies whether the API product exists.
  • requireCallbackUrl (type: boolean(), default: nil) - Boolean flag that specifies whether a callback URL is required.
  • siteId (type: String.t, default: nil) - Name of the portal.
  • snapshotExists (type: boolean(), default: nil) - Boolean flag that specifies whether a snapshot of the OpenAPI Specification that is used to render API reference documentation exists.
  • snapshotModified (type: String.t, default: nil) - Time the snapshot of the OpenAPI Specification was last modified in milliseconds since epoch.
  • snapshotOutdated (type: boolean(), default: nil) - Boolean flag that specifies whether the snapshot of the OpenAPI Specification is out of date.
  • snapshotSourceMissing (type: boolean(), default: nil) - Boolean flag that specifies whether the snapshot of the OpenAPI Specification is missing.
  • snapshotState (type: String.t, default: nil) - Status of the snapshot of the OpenAPI Specification that is used to render API reference documentation.
  • specContent (type: String.t, default: nil) - OpenAPI Specification content.
  • specId (type: String.t, default: nil) - ID of the OpenAPI Specification.
  • specModified (type: String.t, default: nil) - Time the OpenAPI Specification was last modified in milliseconds since epoch.
  • specTitle (type: String.t, default: nil) - Title of the OpenAPI Specification.
  • title (type: String.t, default: nil) - Title of the API.
  • visibility (type: boolean(), default: nil) - Boolean flag that specifies whether the API is visible to all users (public).

Attributes

  • apiResources (type: list(String.t), default: nil) - Comma-separated list of API resources to be bundled in the API Product.

Attributes

  • apiproduct (type: String.t, default: nil) - Name of the API product.
  • status (type: String.t, default: nil) - Status of the API product.

Metadata describing the API proxy

Attributes

  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • apiProducts (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProductRef.t), default: nil) - List of API products associated with the app.
  • appId (type: String.t, default: nil) - ID of the app.
  • attributes (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t), default: nil) - List of attributes.
  • callbackUrl (type: String.t, default: nil) - Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to apps.
  • companyName (type: String.t, default: nil) - Name of the company that owns the app.
  • createdAt (type: String.t, default: nil) - Output only. Unix time when the app was created.
  • credentials (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Credential.t), default: nil) - Output only. Set of credentials for the app. Credentials are API key/secret pairs associated with API products.
  • developerId (type: String.t, default: nil) - ID of the developer.
  • keyExpiresIn (type: String.t, default: nil) - Duration, in milliseconds, of the consumer key that will be generated for the app. The default value, -1, indicates an infinite validity period. Once set, the expiration can't be updated. json key: keyExpiresIn
  • lastModifiedAt (type: String.t, default: nil) - Output only. Last modified time as milliseconds since epoch.
  • name (type: String.t, default: nil) - Name of the app.
  • scopes (type: list(String.t), default: nil) - Scopes to apply to the app. The specified scope names must already exist on the API product that you associate with the app.
  • status (type: String.t, default: nil) - Status of the credential.

Attributes

  • approvedEmails (type: String.t, default: nil) - Individual email addresses or email domains that can create accounts on the portal.

Attributes

  • created (type: String.t, default: nil) - Creation time of the query

Attributes

  • expires (type: String.t, default: nil) - Query result will be unaccessable after this time.
  • self (type: String.t, default: nil) - Self link of the query results

Attributes

  • code (type: integer(), default: nil) - Error code when there is a failure.

Key-value pair to store extra metadata.

Attributes

  • attribute (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t), default: nil) - List of attributes.

Attributes

  • created (type: String.t, default: nil) - Time the audience was created in milliseconds since epoch.
  • description (type: String.t, default: nil) - Description of the audience.
  • id (type: String.t, default: nil) - ID of the audience.
  • membershipType (type: String.t, default: nil) - Type of membership.
  • name (type: String.t, default: nil) - Name of audience.
  • resources (type: list(String.t), default: nil) - List of resources assigned to the audience.
  • teams (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumerTeam.t), default: nil) - List of teams assigned to the audience.
  • users (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1UserData.t), default: nil) - List of users assigned to the audience.

Attributes

  • audience (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Audience.t, default: nil) - Details of the audience.
  • entitled (type: boolean(), default: nil) - Boolean flag that specifies whether the audience is entitled.

Attributes

  • ok (type: boolean(), default: nil) - Boolean flag that specifies whether the server status is OK.

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CapiServerStatus.t, default: nil) - Status of the server.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

An X.509 certificate as defined in RFC 5280.

Attributes

  • certInfo (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CertInfo.t), default: nil) - The chain of certificates under this name.

Attributes

  • action (type: String.t, default: nil) - Type of access requested for the provided resource path.
  • resourcePath (type: String.t, default: nil) - Resource path.

Attributes

  • data (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CheckAccess.t), default: nil) - Resources to check access permissions.

Attributes

  • data (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CheckAccessVerdict.t), default: nil) - Results of the check access requests.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • action (type: String.t, default: nil) - Access that was attempted
  • resourcePath (type: String.t, default: nil) - Resource path.
  • verdict (type: String.t, default: nil) - Results of the check access request. "unknown" is returned if the resource path is not found

Attributes

  • matchWildCards (type: boolean(), default: nil) -
  • name (type: String.t, default: nil) -

Attributes

  • apps (type: list(String.t), default: nil) -
  • attributes (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t), default: nil) - A list of attributes
  • createdAt (type: String.t, default: nil) - Output only. Created time as milliseconds since epoch. json key: createdAt
  • displayName (type: String.t, default: nil) - company name displayed in the UI
  • lastModifiedAt (type: String.t, default: nil) - Output only. Modified time as milliseconds since epoch. json key: lastModifiedAt
  • name (type: String.t, default: nil) - Name of the company. Characters you can use in the name are restricted to: A-Z0-9._-$ %.
  • organization (type: String.t, default: nil) - the org that the company is created
  • status (type: String.t, default: nil) - The status of the company

Attributes

  • apiProducts (type: list(String.t), default: nil) - Any API Products the app consumes
  • appFamily (type: String.t, default: nil) -
  • appId (type: String.t, default: nil) - The id of the app.
  • attributes (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t), default: nil) - A list of attributes.
  • callbackUrl (type: String.t, default: nil) - The callbackUrl is used by OAuth 2.0 authorization servers to communicate authorization codes back to apps.
  • companyName (type: String.t, default: nil) - The name of the company owns the app
  • createdAt (type: String.t, default: nil) - Output only. created time of this environment as milliseconds since epoch. JSON key: createdAt
  • credentials (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Credential.t), default: nil) - Output only. A set of credentials for the app credentials are key/secret pairs
  • keyExpiresIn (type: String.t, default: nil) - A setting, in milliseconds, for the lifetime of the consumer key that will be generated for the developer app. The default value, -1, indicates an infinite validity period. Once set, the expiration can't be updated. json key: keyExpiresIn
  • lastModifiedAt (type: String.t, default: nil) - Output only. Modified time as milliseconds since epoch. json key: lastModifiedAt
  • name (type: String.t, default: nil) - The resoure id of the app. JSON key: name
  • scopes (type: list(String.t), default: nil) - The scopes to apply to the app. The specified scope names must already exist on the API product that you associate with the app.
  • status (type: String.t, default: nil) - The status of the credential.

Attributes

  • apiProducts (type: list(any()), default: nil) - A list of api products this credential can be used for.
  • attributes (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t), default: nil) - A list of attributes tied to the credential.
  • consumerKey (type: String.t, default: nil) - The consumer key.
  • consumerSecret (type: String.t, default: nil) - The secret key.
  • expiresAt (type: String.t, default: nil) - Unix time when the app was created json key: expiresAt
  • issuedAt (type: String.t, default: nil) - Unix time when the app was issued json key: issuedAt
  • scopes (type: list(String.t), default: nil) - The scopes to apply to the app. The specified scope names must already exist on the API product that you associate with the app.
  • status (type: String.t, default: nil) - The status of the credential.

Version of the API proxy configuration schema. Currently, only 4.0 is supported.

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PortalApp.t, default: nil) - Details of the app.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • created (type: String.t, default: nil) - Time the audience was created in milliseconds since epoch.
  • description (type: String.t, default: nil) - Description of the auidence.
  • id (type: String.t, default: nil) - ID of the audience.
  • membershipType (type: String.t, default: nil) - Type of membership.
  • name (type: String.t, default: nil) - Name of the audience.
  • resources (type: list(String.t), default: nil) - List of resource entitlements assigned to the audience.
  • teams (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumersTeam.t), default: nil) - List of teams assigned to the audience.
  • users (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumerUser.t), default: nil) - List of users assigned to the audience.

Attributes

  • familyName (type: String.t, default: nil) - Last name.
  • givenName (type: String.t, default: nil) - First name.
  • userName (type: String.t, default: nil) - Username.

Attributes

  • apps (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PortalApp.t), default: nil) - List of apps associated with the team.
  • audiences (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Audience.t), default: nil) - Audiences to which the team is assigned.
  • created (type: String.t, default: nil) - Time the team was created in milliseconds since epoch.
  • description (type: String.t, default: nil) - Description of the team.
  • id (type: String.t, default: nil) - ID of the team.
  • memberCount (type: integer(), default: nil) - Number of members on the team.
  • memberships (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumerTeamMembership.t), default: nil) - List of team members.
  • name (type: String.t, default: nil) - Name of the team.
  • pointOfContact (type: String.t, default: nil) - Point of contact for the team.
  • users (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1UserData.t), default: nil) - List of users that are members of the team.

Attributes

  • active (type: boolean(), default: nil) - Boolean flag that specifies whether the user account is active.
  • apps (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PortalApp.t), default: nil) - List of apps associated with the user.
  • audiences (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumerAudience.t), default: nil) - List of audiences to which the user is assigned.
  • customFieldValues (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomFieldValue.t), default: nil) - List of custom fields entered during user account registration.
  • email (type: String.t, default: nil) - Email address of the user.
  • id (type: String.t, default: nil) - ID of the user.
  • name (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumerName.t, default: nil) - Name of the user.
  • passwordLastModified (type: String.t, default: nil) - Time the password was last modified in milliseconds since epoch.
  • teams (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumersTeam.t), default: nil) - List of teams to which the user is assigned.
  • verified (type: boolean(), default: nil) - Boolean flag that specifies whether the user account has been verified.

Attributes

  • data (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumerUser.t), default: nil) - List of users.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of operation. message is a reserved word
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumerUser.t, default: nil) - Details of the user.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • apps (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PortalApp.t), default: nil) - List of apps associated with the team.
  • audiences (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumerAudience.t), default: nil) - List of audiences to which the team is assigned.
  • created (type: String.t, default: nil) - Time the team was created in milliseconds since epoch.
  • description (type: String.t, default: nil) - Description of the team.
  • id (type: String.t, default: nil) - ID of the team.
  • memberCount (type: integer(), default: nil) -
  • memberships (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumerTeamMembership.t), default: nil) - List of members and roles.
  • name (type: String.t, default: nil) - Name of the team.
  • pointOfContact (type: String.t, default: nil) - Point of contact for the team.
  • users (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ConsumerUser.t), default: nil) - List of users assigned to the team.

Attributes

  • apiProducts (type: list(String.t), default: nil) - List of associated API products.
  • attributes (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t), default: nil) - List of attributes.
  • callbackUrl (type: String.t, default: nil) - Callback URL.
  • description (type: String.t, default: nil) - Description of the app.
  • name (type: String.t, default: nil) - User-friendly display name for the app.
  • owner (type: String.t, default: nil) - Owner of the app.
  • ownerType (type: String.t, default: nil) - Type of owner.

Response message for the CreateIdentityProvider RPC.

Attributes

  • apiProducts (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProductRef.t), default: nil) - List of API products this credential can be used for.
  • attributes (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t), default: nil) - List of attributes associated with this credential.
  • consumerKey (type: String.t, default: nil) - Consumer key.
  • consumerSecret (type: String.t, default: nil) - Secret key.
  • expiresAt (type: String.t, default: nil) - Time the credential will expire in milliseconds since epoch.
  • issuedAt (type: String.t, default: nil) - Time the credential was issued in milliseconds since epoch.
  • scopes (type: list(String.t), default: nil) - List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app.
  • status (type: String.t, default: nil) - Status of the credential.

Attributes

  • content (type: String.t, default: nil) - Custom editor update payload that contains the update type and the relevant data.
  • kind (type: String.t, default: nil) - Type of payload.

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomCssData.t, default: nil) - Details of the custom CSS.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • compilationError (type: String.t, default: nil) - Compilation error, if applicable.
  • created (type: String.t, default: nil) - Time the custom CSS was created in milliseconds since epoch.
  • css (type: String.t, default: nil) - CSS content of the portal.
  • customScssDraft (type: String.t, default: nil) - Custom style overrides (draft).
  • customScssPublished (type: String.t, default: nil) - Custom style overrides (published).
  • editorModeDraft (type: String.t, default: nil) - Editor mode (draft).
  • editorModePublished (type: String.t, default: nil) - Editor mode (published).
  • enabled (type: boolean(), default: nil) - Boolean flag that specifies whether the custom CSS is enabled.
  • faviconUrlDraft (type: String.t, default: nil) - URL for favicon (draft).
  • faviconUrlPublished (type: String.t, default: nil) - URL for favicon (published).
  • id (type: integer(), default: nil) - ID of the custom CSS.
  • isThemeEditorEnabled (type: boolean(), default: nil) - Boolean flag that specifies whether theme editor is enabled.
  • logoUrlDraft (type: String.t, default: nil) - URL for desktop logo (draft).
  • logoUrlPublished (type: String.t, default: nil) - URL for desktop logo (published).
  • migrationState (type: String.t, default: nil) - Migration status of portal.
  • mobileLogoUrlDraft (type: String.t, default: nil) - URL for mobile logo (draft).
  • mobileLogoUrlPublished (type: String.t, default: nil) - URL for mobile logo (published).
  • modified (type: String.t, default: nil) - Time the custom CSS was last updated in milliseconds since epoch.
  • overridesDraft (type: String.t, default: nil) - Variable overrides (draft).
  • overridesPublished (type: String.t, default: nil) - Variable overrides (published).
  • published (type: String.t, default: nil) - Time the custom CSS was last published in milliseconds since epoch.
  • siteId (type: String.t, default: nil) - Name of the portal.
  • variablesDraft (type: String.t, default: nil) - Basic style settings (draft).
  • variablesPublished (type: String.t, default: nil) - Basic style settings (published).

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomDomainConfigData.t, default: nil) - Details for the custom domain configuration.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • domain (type: String.t, default: nil) - Name of the custom domain.
  • force (type: boolean(), default: nil) - Boolean flag that specifies whether to force the update.
  • id (type: String.t, default: nil) - ID of the custom domain configuration.
  • redirectHttps (type: boolean(), default: nil) - Boolean flag that specifies whether to redirect to HTTPS.
  • siteId (type: String.t, default: nil) - Name of the portal.
  • subdomain (type: String.t, default: nil) - Name of the subdomain.
  • tlsAlias (type: String.t, default: nil) - Name of the TLS keystore alias.
  • tlsKeystore (type: String.t, default: nil) - Name of the TLS keystore.

Attributes

  • fieldName (type: String.t, default: nil) - Name of the custom field.
  • fieldValue (type: String.t, default: nil) - Value of the custom field.

Attributes

  • active (type: boolean(), default: nil) - Boolean flag that specifies whether the field is enabled.
  • fieldName (type: String.t, default: nil) - Name of the custom field.
  • fieldType (type: String.t, default: nil) - Type of custom registration field.
  • required (type: boolean(), default: nil) - Boolean flag that specifies whether the field is required.
  • sortOrder (type: integer(), default: nil) - Sort order for the custom field.

Attributes

  • chartType (type: String.t, default: nil) - This field contains the chart type for the report
  • comments (type: list(String.t), default: nil) - Legacy field: not used. This field contains a list of comments associated with custom report
  • createdAt (type: String.t, default: nil) - Output only. Unix time when the app was created json key: createdAt
  • dimensions (type: list(String.t), default: nil) - This contains the list of dimensions for the report
  • displayName (type: String.t, default: nil) - This is the display name for the report
  • environment (type: String.t, default: nil) - Output only. Environment name
  • filter (type: String.t, default: nil) - This field contains the filter expression
  • fromTime (type: String.t, default: nil) - Legacy field: not used. Contains the from time for the report
  • lastModifiedAt (type: String.t, default: nil) - Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt
  • lastViewedAt (type: String.t, default: nil) - Output only. Last viewed time of this entity as milliseconds since epoch
  • limit (type: String.t, default: nil) - Legacy field: not used This field contains the limit for the result retrieved
  • metrics (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomReportMetric.t), default: nil) - Required. This contains the list of metrics
  • name (type: String.t, default: nil) - Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id
  • offset (type: String.t, default: nil) - Legacy field: not used. This field contains the offset for the data
  • organization (type: String.t, default: nil) - Output only. Organization name
  • properties (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ReportProperty.t), default: nil) - This field contains report properties such as ui metadata etc.
  • sortByCols (type: list(String.t), default: nil) - Legacy field: not used much. Contains the list of sort by columns
  • sortOrder (type: String.t, default: nil) - Legacy field: not used much. Contains the sort order for the sort columns
  • tags (type: list(String.t), default: nil) - Legacy field: not used. This field contains a list of tags associated with custom report
  • timeUnit (type: String.t, default: nil) - This field contains the time unit of aggregation for the report
  • toTime (type: String.t, default: nil) - Legacy field: not used. Contains the end time for the report
  • topk (type: String.t, default: nil) - Legacy field: not used. This field contains the top k parameter value for restricting the result

This encapsulates a metric property of the form sum(message_count) where name is message_count and function is sum

Attributes

  • variables (type: map(), default: nil) - Map of keys to style variables. Style variables can be one of many different structures created by the UI that the server can turn into styling.

Attributes

  • copiedVariables (type: map(), default: nil) - writeOnly: true
  • enums (type: map(), default: nil) - Array of values of type EnumOption. This is untyped beyond being a JSON object as the metadata can be in any format/structure.
  • gui (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1GuiSection.t), default: nil) - JSON node which represents the input fields in the UI. The server does not type this structure beyond being plain JSON; the UI handles the rendering.
  • properties (type: map(), default: nil) - Map of properties to their kinds. Multiple kinds are allowed on each variable. The value of this map is a list of strings, where each string is a kind associated with the property.

Attributes

  • url (type: String.t, default: nil) - GCS signed url. Signed URLs provide a way to give time-limited read or write access to anyone in possession of the URL, regardless of whether they have a Google account.

Attributes

  • faultJSONPaths (type: list(String.t), default: nil) - List of JSON paths that specify JSON elements to be filtered from JSON payloads in error flows.
  • faultXPaths (type: list(String.t), default: nil) - List of XPaths that specify XML elements to be filtered from XML payloads in error flows.
  • name (type: String.t, default: nil) - The DebugMask resource name.
  • namespaces (type: map(), default: nil) - Map of namespaces to uris.
  • requestJSONPaths (type: list(String.t), default: nil) - List of JSON paths that specify JSON elements to be filtered from JSON request message payloads.
  • requestXPaths (type: list(String.t), default: nil) - List of XPaths that specify XML elements to be filtered from XML request message payloads.
  • responseJSONPaths (type: list(String.t), default: nil) - List of JSON paths that specify JSON elements to be filtered from JSON response message payloads.
  • responseXPaths (type: list(String.t), default: nil) - List of XPaths that specify XML elements to be filtered from XML response message payloads.
  • variables (type: list(String.t), default: nil) - List of variables that should be masked from debug output.

Attributes

  • count (type: integer(), default: nil) - Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10.
  • filter (type: String.t, default: nil) - Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition.
  • name (type: String.t, default: nil) - A unique ID for this DebugSession.
  • timeout (type: String.t, default: nil) - Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided.
  • tracesize (type: integer(), default: nil) - Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120.
  • validity (type: integer(), default: nil) - Optional. The length of time, in seconds, that this debug session is valid, starting from when it's received in the control plane. Min = 1, Max = 15, Default = 10.

A transaction contains all of the debug information of the entire message flow of an API call processed by the runtime plane. The information is collected and recorded at critical points of the message flow in the runtime apiproxy.

Attributes

  • defaultAnonAllowed (type: boolean(), default: nil) - Boolean flag that specifies the default visibility for pages and API products that are published on the portal.

Attributes

  • message (type: String.t, default: nil) - The response contains only a message field.

Attributes

  • apiProxy (type: String.t, default: nil) - API proxy.
  • basePath (type: String.t, default: nil) - Base path for the deployment.
  • deployStartTime (type: String.t, default: nil) - Time the API proxy was marked deployed in the control plane in millisconds since epoch.
  • environment (type: String.t, default: nil) - Environment.
  • pods (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PodStatus.t), default: nil) - Status reported by runtime pods.
  • revision (type: String.t, default: nil) - API proxy revision.

Attributes

  • attributes (type: map(), default: nil) - Additional key-value metadata about the deployment.
  • basePath (type: String.t, default: nil) - Base path where the application needs to be hosted. Default value is assumed to be "/".
  • location (type: String.t, default: nil) - The location of the proxy bundle, as a uri.
  • name (type: String.t, default: nil) - The name of the API or shared flow revision to be deployed. Must be of the form 'organizations/{org}/apis/{api}/revisions/{rev}' or 'organizations/{org}/sharedflows/{sf}/revisions/{rev}'.

Attributes

  • accessType (type: String.t, default: nil) - Access type.

Attributes

  • apiProducts (type: list(String.t), default: nil) - List of API products associated with the developer app.
  • appFamily (type: String.t, default: nil) - Developer app family.
  • appId (type: String.t, default: nil) - ID of the developer app.
  • attributes (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t), default: nil) - List of attributes for the developer app.
  • callbackUrl (type: String.t, default: nil) - Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.
  • createdAt (type: String.t, default: nil) - Output only. Time the developer app was created in milliseconds since epoch.
  • credentials (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Credential.t), default: nil) - Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products.
  • developerId (type: String.t, default: nil) - ID of the developer.
  • keyExpiresIn (type: String.t, default: nil) - Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of -1, the API key never expires. The expiration time can't be updated after it is set.
  • lastModifiedAt (type: String.t, default: nil) - Output only. Time the developer app was modified in milliseconds since epoch.
  • name (type: String.t, default: nil) - Name of the developer app.
  • scopes (type: list(String.t), default: nil) - Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
  • status (type: String.t, default: nil) - Status of the credential. Valid values include approved or revoked.

Attributes

  • apiProducts (type: list(any()), default: nil) - List of API products for which the credential can be used.
  • attributes (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t), default: nil) - List of attributes associated with the credential.
  • consumerKey (type: String.t, default: nil) - Consumer key.
  • consumerSecret (type: String.t, default: nil) - Secret key.
  • expiresAt (type: String.t, default: nil) - Time the developer app expires in milliseconds since epoch.
  • issuedAt (type: String.t, default: nil) - Time the developer app was created in milliseconds since epoch.
  • scopes (type: list(String.t), default: nil) - Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app.
  • status (type: String.t, default: nil) - Status of the credential. Valid values include approved or revoked.

This message type encapsulates a metric grouped by dimension

Attributes

  • cname (type: String.t, default: nil) - Canonical name (CNAME) record.
  • domain (type: String.t, default: nil) - Domain name.

Attributes

  • verified (type: boolean(), default: nil) - Boolean flag that specifies whether the domain was verified.

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DomainVerified.t, default: nil) - Details about the domain.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • createdBy (type: String.t, default: nil) - Not used by Apigee hybrid.
  • created_at (type: String.t, default: nil) - Time the team was created in milliseconds since epoch.
  • displayName (type: String.t, default: nil) - User-friendly display name.
  • id (type: String.t, default: nil) - ID of the team.
  • name (type: String.t, default: nil) - Name of the team.
  • organization (type: String.t, default: nil) - Name of the Apigee organization.
  • updatedBy (type: String.t, default: nil) - Not used by Apigee hybrid.
  • updated_at (type: String.t, default: nil) - Time the team was last modified in milliseconds since epoch.

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ThemeEditorSchema.t, default: nil) - Details of the theme editor schema.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Details of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1EmailTemplateBody.t, default: nil) - Contents of the body of the email template.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • emailTemplateId (type: String.t, default: nil) - ID of the email template.
  • htmlBody (type: String.t, default: nil) - Contents of the body of email (HTML format).
  • id (type: integer(), default: nil) - Not used by hybrid.
  • modified (type: String.t, default: nil) - Time the email template was last modified in milliseconds since epoch.
  • modifiedBy (type: String.t, default: nil) - Not used by Apigee hybrid.
  • siteId (type: String.t, default: nil) - Name of the portal.
  • subject (type: String.t, default: nil) - Subject of the email.
  • textBody (type: String.t, default: nil) - Contents of the body of the email (text format).
  • title (type: String.t, default: nil) - Name of the email template.
  • variables (type: list(String.t), default: nil) - List of variables that can be used in the email template.

Metadata common to many entities in this API.

Attributes

  • createdAt (type: String.t, default: nil) - Output only. Creation time of this environment as milliseconds since epoch.
  • description (type: String.t, default: nil) - Optional. Description of the environment.
  • displayName (type: String.t, default: nil) - Optional. Display name for this environment.
  • lastModifiedAt (type: String.t, default: nil) - Output only. Last modification time of this environment as milliseconds since epoch.
  • name (type: String.t, default: nil) - Required. Name of the environment. Values must match the regular expression ^[.\\p{Alnum}-_]{1,255}$
  • properties (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Properties.t, default: nil) - Optional. Key-value pairs that may be used for customizing the environment.

Attributes

  • createTime (type: DateTime.t, default: nil) - The time at which this environment config was created.
  • debugMask (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DebugMask.t, default: nil) - Debug mask that applies to all deployments in the environment.
  • deployments (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeploymentConfig.t), default: nil) - A list of deployments in the environment
  • featureFlags (type: map(), default: nil) - Feature flags inherited from the org and environment parents.
  • flowhooks (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1FlowHookConfig.t), default: nil) - A list of flow hooks in the environment.
  • keystores (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeystoreConfig.t), default: nil) - A list of keystores in the environment.
  • name (type: String.t, default: nil) - The name of the environment config. Must be of the form 'organizations/{org}/environments/{env}/configs/{config_id}
  • provider (type: String.t, default: nil) - This field can be used by the control plane to add some context information about itself. This information could help detect the source of the document during diagnostics and debugging.
  • pubsubTopic (type: String.t, default: nil) - Name of the pubsub topic for this environment.
  • resourceReferences (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ReferenceConfig.t), default: nil) - A list of resource references in the environment.
  • resources (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ResourceConfig.t), default: nil) - A list of resource versions in the environment.
  • sequenceNumber (type: String.t, default: nil) - A sequence number that defines an ordering on environment configs. No two configs under an environment will ever have the same sequence number. A higher sequence number means that the config was deployed more recently than one with a lower sequence number.
  • targets (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1TargetServerConfig.t), default: nil) - A list of target servers in the environment. Disabled target servers are not included.

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1FileData.t, default: nil) - Details for the file.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • extension (type: String.t, default: nil) - File extension.
  • filename (type: String.t, default: nil) - Name of the file.
  • fullUrl (type: String.t, default: nil) - Full URL to access the file.
  • height (type: integer(), default: nil) - Not used by Apigee hybrid.
  • image (type: boolean(), default: nil) - Boolean flag that specifies whether the file is an image.
  • modified (type: String.t, default: nil) - Time the file was last modified in milliseconds since epoch.
  • relUrl (type: String.t, default: nil) - Relative URL to access the file.
  • size (type: String.t, default: nil) - File size.
  • thumbUrl (type: String.t, default: nil) - URL for the thumbnail.
  • versionedRelUrl (type: String.t, default: nil) - URL for the current version of the file.
  • width (type: integer(), default: nil) - Not used by Apigee hybrid.

Attributes

  • filename (type: String.t, default: nil) - Name of the file.

Attributes

  • continueOnError (type: boolean(), default: nil) - Optional. Flag that specifies whether execution should continue if the flow hook throws an exception. Set to true to continue execution. Set to false to stop execution if the flow hook throws an exception.Defaults to true.
  • description (type: String.t, default: nil) - Description of the flow hook.
  • flowHookPoint (type: String.t, default: nil) - Output only. Where in the API call flow the flow hook is invoked. Must be one of PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, or PostTargetFlowHook.
  • sharedFlow (type: String.t, default: nil) - Shared flow attached to this flow hook, or empty if there is none attached.

Attributes

  • continueOnError (type: boolean(), default: nil) - Should the flow abort after an error in the flow hook. Should default to true if unset.
  • name (type: String.t, default: nil) - The name of the flow hook. Must be of the form 'organizations/{org}/environments/{env}/flowhooks/{point}''. Known points are PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, and PostTargetFlowHook
  • sharedFlowName (type: String.t, default: nil) - The name of the shared flow to invoke. Must be of the form 'organizations/{org}/sharedflows/{sharedflow}'.

Response message for the GetIdentityProvider RPC.

Response message for the GetZone RPC.

Attributes

  • elements (type: list(any()), default: nil) - List of values for the element.
  • kind (type: String.t, default: nil) - Kind.
  • title (type: String.t, default: nil) - Title of the element.

Attributes

  • aliasId (type: String.t, default: nil) - The alias id. Must exist in the keystore referred to by reference.
  • reference (type: String.t, default: nil) - The reference name. Must be of the form: organizations/{org}/environments/{env}/references/{ref}.

Attributes

  • action (type: String.t, default: nil) - Approve or revoke API key.

A collection of key, value string pairs

A datastore for Certificates and Aliases

Attributes

  • alias (type: String.t, default: nil) - Alias for the keystore.
  • domainNames (type: list(String.t), default: nil) - Domains names bound to the subject of the certificate.
  • expiryDate (type: String.t, default: nil) - Expiration date.
  • valid (type: boolean(), default: nil) - Boolean flag that specifies whether the keystore alias is valid.

Attributes

  • aliases (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AliasRevisionConfig.t), default: nil) - Aliases in the keystore.
  • name (type: String.t, default: nil) - The resource name. Must be of the form: 'organizations/{org}/environments/{env}/keystores/{keystore}'.

Attributes

  • data (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PortalKeystore.t), default: nil) - Details for the keystores.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • data (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiDocBody.t), default: nil) - Details for all published APIs.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • apiProduct (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct.t), default: nil) - Lists all API product names defined for an organization.

Attributes

  • proxies (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxy.t), default: nil) -

Attributes

  • app (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1App.t), default: nil) -

Attributes

  • data (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ZoneAudienceEnabled.t), default: nil) - Audience feature flag setting for each zone.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • company (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Company.t), default: nil) - A list of company.

Attributes

  • app (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CompanyApp.t), default: nil) - A list of apps for a company.

Attributes

  • data (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PortalApp.t), default: nil) - List of apps.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

This message encapsulates a list of custom report definitions

Attributes

  • sessions (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Sesssion.t), default: nil) - Session info that includes debug session ID and the first transaction creation timestamp.

Attributes

  • deployments (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Deployment.t), default: nil) - List of deployments.

Attributes

  • app (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1DeveloperApp.t), default: nil) - List of developer apps and their credentials.

Attributes

  • data (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1EdgeTeam.t), default: nil) - Details of the team.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • data (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1FileData.t), default: nil) - Details for the files.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • issuers (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ServiceIssuersMapping.t), default: nil) - Lists of hybrid services and its trusted issuer email ids.

Response message for the ListIdentityProviders RPC.

Attributes

  • data (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1MenuItemData.t), default: nil) - Details of the menu items.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • data (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1MenuTypeData.t), default: nil) - Details of the menu types.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • developer (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Developer.t), default: nil) - List of developers.

Attributes

  • organizations (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1OrganizationProjectMapping.t), default: nil) - List of Apigee organizations and associated GCP projects.

Attributes

  • data (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PageBody.t), default: nil) - Details for all pages.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • data (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ProxySpec.t), default: nil) - Details for the OpenAPI Specifications.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • data (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PortalApiProduct.t), default: nil) - List of publishable API products.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • sharedFlows (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SharedFlow.t), default: nil) -

Response message for the ListZones RPC.

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1MenuItemData.t, default: nil) - Details of the menu item.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of operation.

Attributes

  • draft (type: boolean(), default: nil) - Boolean flag that specifies whether the menu items is a draft.
  • isNested (type: boolean(), default: nil) - Boolean flag that specifies whether the menu item is a submenu (nested).
  • menuItemId (type: String.t, default: nil) - ID of the menu item.
  • menuTypeId (type: String.t, default: nil) - ID of the menu type.
  • modified (type: String.t, default: nil) - Time the menu item was last modified in milliseconds since epoch.
  • modifiedBy (type: String.t, default: nil) - Not used by Apigee hybrid.
  • name (type: String.t, default: nil) - Name of the menu item.
  • pageId (type: String.t, default: nil) - ID of the page associated with the menu item.
  • priority (type: integer(), default: nil) - Priority order of the menu item.
  • url (type: String.t, default: nil) - Relative URL to the page associated with the menu item.

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1MenuTypeData.t, default: nil) - Details of the menu type.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • friendlyId (type: String.t, default: nil) - Display name for the menu type.
  • menuTypeId (type: String.t, default: nil) - ID of the menu type.
  • modified (type: String.t, default: nil) - Time the menu type was last modified in milliseconds since epoch.
  • modifiedBy (type: String.t, default: nil) - Not used by Apigee hybrid.
  • name (type: String.t, default: nil) - Name of the menu type.
  • siteId (type: String.t, default: nil) - Name of the portal.

This message type encapsulates additional information about query execution

This message type encapsulates the metric data point Example { "name": "sum(message_count)", "values" : [ {

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1MetricsData.t, default: nil) - Object containing metrics related to the organization.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • totalNumberOfSites (type: String.t, default: nil) - Total number of portals.

Attributes

  • isNested (type: boolean(), default: nil) - Boolean flag that specifies whether the menu item is a submenu (nested).

Attributes

  • Response (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1OptimizedStatsResponse.t, default: nil) - This field wraps the stats response for Js Optimized Scenario with a Response key. E.g. { "Response": {

Attributes

  • data (type: list(any()), default: nil) -

This message type encapsulates a response format for Js Optimized Scenario

Attributes

  • analyticsRegion (type: String.t, default: nil) - Required. Primary GCP region for analytics data storage. For valid values, see Create an organization.
  • attributes (type: list(String.t), default: nil) - Not used by Apigee hybrid.
  • createdAt (type: String.t, default: nil) - Output only. Time that the Apigee organization was created in milliseconds since epoch.
  • customerName (type: String.t, default: nil) - Not used by Apigee hybrid.
  • description (type: String.t, default: nil) - Description of the Apigee organization.
  • displayName (type: String.t, default: nil) -
  • environments (type: list(String.t), default: nil) - Output only. List of environments in the Apigee organization.
  • lastModifiedAt (type: String.t, default: nil) - Output only. Time that the Apigee organization was last modified in milliseconds since epoch.
  • name (type: String.t, default: nil) - Required. Name of the Apigee organization.
  • properties (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Properties.t, default: nil) - Properties defined in the Apigee organization profile.
  • runtimeType (type: String.t, default: nil) - Output only. Runtime type of the Apigee organization based on the Apigee subscription purchased.
  • subscriptionType (type: String.t, default: nil) - Output only. Subscription type of the Apigee organization. Valid values include trial (free, limited, and for evaluation purposes only) or paid (full subscription has been purchased). See Apigee pricing.
  • type (type: String.t, default: nil) - Not used by Apigee hybrid.

Attributes

  • organization (type: String.t, default: nil) - Name of the Apigee organization.
  • projectIds (type: list(String.t), default: nil) - List of GCP projects associated with the Apigee organization.

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PageBody.t, default: nil) - Details of page.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • active (type: boolean(), default: nil) - Boolean flag that specifies whether the page is published.
  • anonAllowed (type: boolean(), default: nil) - Boolean flag that specifies whether all or only registered users can access the page.
  • apiProduct (type: String.t, default: nil) - Name of the API product.
  • content (type: String.t, default: nil) - Published contents of the page.
  • created (type: String.t, default: nil) - Time the page was created in milliseconds since epoch.
  • description (type: String.t, default: nil) - Description of the page.
  • draft (type: String.t, default: nil) - Draft content of the page.
  • friendlyId (type: String.t, default: nil) - User-friendly page ID (page URL).
  • generatedContent (type: list(String.t), default: nil) - Reserved for future use.
  • id (type: String.t, default: nil) - ID of the page.
  • layout (type: String.t, default: nil) - Page layout. (Internal use only.)
  • modified (type: String.t, default: nil) - Time the page was last modified in milliseconds since epoch.
  • modifiedBy (type: String.t, default: nil) - Not used by Apigee hybrid.
  • name (type: String.t, default: nil) - Title of the page.
  • published (type: String.t, default: nil) - Time the page was last published in milliseconds since epoch.
  • publishedBy (type: String.t, default: nil) - Not used by Apigee hybrid.
  • siteId (type: String.t, default: nil) - ID of the portal.
  • submenuId (type: String.t, default: nil) - Not used by Apigee hybrid.
  • systemGenerated (type: boolean(), default: nil) - System-generated page. (Internal use only.)
  • type (type: String.t, default: nil) - Reserved for future use.

Attributes

  • html (type: String.t, default: nil) - Page content in HTML.
  • title (type: String.t, default: nil) - Page title.

Attributes

  • content (type: String.t, default: nil) - Contents of page.

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PageContent.t, default: nil) - Page content.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • appVersion (type: String.t, default: nil) - Version of the application running in the pod.

Point is a group of information collected by runtime plane at critical points of the message flow of the processed API request. This is a list of supported point IDs, categorized to three major buckets. For each category, debug points that we are currently supporting are listed below

Attributes

  • approvalType (type: String.t, default: nil) - Approval type (automatic or manual).
  • description (type: String.t, default: nil) - Description of the API product.
  • displayName (type: String.t, default: nil) - Display name for the API product used in the UI.
  • isChecked (type: boolean(), default: nil) - Not used by Apigee hybrid.
  • isPublic (type: boolean(), default: nil) - Boolean flag that specifies whether the API product is public or private.
  • name (type: String.t, default: nil) - Name of the API product.
  • proxies (type: list(String.t), default: nil) - List of API proxies available in the API product.
  • rights (type: String.t, default: nil) - Not used by Apigee hybrid.
  • status (type: String.t, default: nil) - Status of the API product.

Attributes

  • apiProducts (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProductRef.t), default: nil) - List of API products associated with the app.
  • apiProductsFromCredentials (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Credential.t), default: nil) - List of credentials.
  • callbackUrl (type: String.t, default: nil) - Callback URL.
  • created (type: String.t, default: nil) - Time the app was created in milliseconds since epoch.
  • credentials (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Credential.t), default: nil) - List of credentials.
  • description (type: String.t, default: nil) - Description of the app.
  • displayName (type: String.t, default: nil) - User-friendly name of the app used in the UI.
  • id (type: String.t, default: nil) - ID of the app.
  • modified (type: String.t, default: nil) - Time the app was last modified in milliseconds since epoch.
  • name (type: String.t, default: nil) - Name of the app.
  • owner (type: String.t, default: nil) - Owner of the app.
  • ownerType (type: String.t, default: nil) - Type of owner, team or user.
  • status (type: String.t, default: nil) - Status of the app.

Attributes

  • domainSuffix (type: String.t, default: nil) - Domain suffix.
  • proxyDomainSuffix (type: String.t, default: nil) - Proxy domain suffix.

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PortalConfig.t, default: nil) - Details of the portal configuration.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • aliases (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeystoreAlias.t), default: nil) - Aliases for the keystore.
  • name (type: String.t, default: nil) - Name of the keystore.

Attributes

  • description (type: String.t, default: nil) -
  • id (type: String.t, default: nil) -
  • name (type: String.t, default: nil) -
  • type (type: String.t, default: nil) -

Attributes

  • dependentActions (type: list(String.t), default: nil) -
  • description (type: String.t, default: nil) -
  • id (type: String.t, default: nil) -
  • name (type: String.t, default: nil) -
  • type (type: String.t, default: nil) -

Attributes

  • resources (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PortalResource.t), default: nil) -
  • type (type: String.t, default: nil) -

Attributes

  • actions (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PortalResourceAction.t), default: nil) -
  • collection (type: String.t, default: nil) -
  • defaultActions (type: list(String.t), default: nil) -
  • description (type: String.t, default: nil) -
  • id (type: String.t, default: nil) -
  • name (type: String.t, default: nil) -
  • type (type: String.t, default: nil) -

Attributes

  • resourceTypes (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PortalResourceType.t), default: nil) -
  • type (type: String.t, default: nil) -

Message for compatibility with legacy Edge specification for Java Properties object in JSON.

A single property entry in the Properties message.

Attributes

  • created (type: String.t, default: nil) - Time the portal was created in milliseconds since epoch.
  • inDocstore (type: boolean(), default: nil) - Not used by Apigee hybrid.
  • lastModified (type: String.t, default: nil) - Time the portal was last modified in milliseconds since epoch.
  • name (type: String.t, default: nil) - Name of the OpenAPI Specification.
  • proxy (type: String.t, default: nil) - Name of the API proxy.
  • revision (type: integer(), default: nil) - Revision of the API proxy.
  • url (type: String.t, default: nil) - URL of the OpenAPI Specification.

Attributes

  • html (type: String.t, default: nil) - Page contents for the published API.

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1PublishedApisPage.t, default: nil) - Details for the published API.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • csvDelimiter (type: String.t, default: nil) - Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t).
  • dimensions (type: list(String.t), default: nil) - A list of dimensions https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
  • filter (type: String.t, default: nil) - Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
  • groupByTimeUnit (type: String.t, default: nil) - Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
  • limit (type: integer(), default: nil) - Maximum number of rows that can be returned in the result.
  • metrics (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1QueryMetric.t), default: nil) - A list of Metrics
  • name (type: String.t, default: nil) - Asynchronous Query Name.
  • outputFormat (type: String.t, default: nil) - Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.
  • reportDefinitionId (type: String.t, default: nil) - Asynchronous Report ID.
  • timeRange (type: any(), default: nil) - Required. Time range for the query. Can use the following predefined strings to specify the time range: last60minutes last24hours last7days Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ.

Attributes

  • dimensions (type: list(String.t), default: nil) - Dimensions of the AsyncQuery.

A Reference configuration. References must refer to a keystore that also exists in the parent environment.

Attributes

  • name (type: String.t, default: nil) - The name of the reference. Must be of the form 'organizations/{org}/environments/{env}/references/{ref}'.
  • resourceName (type: String.t, default: nil) - The name of the referred resource. Only references to keystore resources are supported. Must be of the form 'organizations/{org}/environments/{env}/keystores/{ks}'.

Attributes

  • property (type: String.t, default: nil) - name of the property
  • value (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t), default: nil) - property values

Attributes

  • location (type: String.t, default: nil) - The location of the resource as a URI.
  • name (type: String.t, default: nil) - The resource name. Only environment-scoped resource files are supported. Must be of the form 'organizations/{org}/environments/{env}/resourcefiles/{type}/{file}/revisions/{rev}'.

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ResourceEntitlementData.t, default: nil) - Details of the entitlement.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • authEntitled (type: boolean(), default: nil) - Boolean flag that specifies whether the resource is available to all registered users.
  • explicitAudiences (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AudienceEntitlement.t), default: nil) - List of explicit audience entitlements.
  • isPublic (type: boolean(), default: nil) - Boolean flag that specifies whether the resource is public.

Result is short for "action result", could be different types identified by "action_result" field. Supported types

Attributes

  • emailTemplateId (type: String.t, default: nil) - ID of the email template.
  • to (type: String.t, default: nil) - Email address to which the test email is sent.

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ServerStatusData.t, default: nil) - Details of the server status.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • dbConnection (type: boolean(), default: nil) -
  • dbUpdateLatest (type: boolean(), default: nil) -
  • defaultSmtpSend (type: boolean(), default: nil) -
  • edgeConnection (type: boolean(), default: nil) -
  • idpConnection (type: boolean(), default: nil) -
  • nfsFolders (type: boolean(), default: nil) -
  • nfsReadAccess (type: boolean(), default: nil) -
  • nfsWriteAccess (type: boolean(), default: nil) -

Attributes

  • emailIds (type: list(String.t), default: nil) - List of trusted issuer email ids.
  • service (type: String.t, default: nil) - String indicating the Apigee service name.

Attributes

  • id (type: String.t, default: nil) - The debug session ID.
  • timestampMs (type: String.t, default: nil) - The first transaction creation timestamp in millisecond, recoreded by UAP.

The metadata describing a shared flow

The metadata describing a shared flow revision.

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SiteData.t, default: nil) - Details for the portal.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • zoneId (type: String.t, default: nil) - ID of the identity zone.
  • siteDomainSuffix (type: String.t, default: nil) - Suffix for the portal domain. By default, this is set to ".apigee.io".
  • orgName (type: String.t, default: nil) - Name of the Apigee organization.
  • trashedBy (type: String.t, default: nil) - Name of the user that deleted the portal.
  • customDomain (type: String.t, default: nil) - Custom domain (if applicable).
  • direction (type: String.t, default: nil) - Type of writing system, such as left-to-right (ltr).
  • portalVersion (type: integer(), default: nil) - Version of the portal.
  • anonAllowedByDefault (type: boolean(), default: nil) - Boolean flag that sets the default visibility for pages and API products that are published on the portal. When set totrue, allows access by all users (public).
  • lastPublished (type: String.t, default: nil) - Time the portal was last published in milliseconds since epoch.
  • itSecretKey (type: String.t, default: nil) - Not used by Apigee hybrid.
  • language (type: String.t, default: nil) - Language for the portal (such as "en").
  • description (type: String.t, default: nil) - Description of the portal.
  • themeVersion (type: String.t, default: nil) - Version of the theme used by the portal. (Internal use only.)
  • timeZone (type: String.t, default: nil) - Time zone.
  • teams (type: list(String.t), default: nil) - Not used by Apigee hybrid.
  • name (type: String.t, default: nil) - Name of the portal.
  • theme (type: String.t, default: nil) - Name of the theme used on the portal (apigee).
  • analyticsScript (type: String.t, default: nil) - Custom HTML/JS analytics script added before the tag on all pages of the site.
  • customDomainEnabled (type: boolean(), default: nil) - Not used currently by Apigee hybrid.
  • stylesheetDirty (type: boolean(), default: nil) - Boolean flag that specifies whether the custom CSS needs to be recalculated.
  • status (type: String.t, default: nil) - Status of the portal indicating whether the portal is published (Active) or unpublished (Inactive).
  • lastModified (type: String.t, default: nil) - Time the portal was last modified in milliseconds since epoch.
  • approvedEmails (type: String.t, default: nil) - List of emails that are allowed to sign up on the portal.
  • iconUrl (type: String.t, default: nil) - Not used by Apigee hybrid.
  • customerId (type: String.t, default: nil) - Not used by Apigee hybrid.
  • lastLogin (type: String.t, default: nil) - Time that a user last signed in to the portal in milliseconds since epoch.
  • iconBg (type: String.t, default: nil) - Not used by Apigee hybrid.
  • defaultURL (type: String.t, default: nil) - Default URL to access the portal.
  • idpEnabled (type: boolean(), default: nil) - Boolean flag that specifies whether an identity provider has been enabled.
  • currentURL (type: String.t, default: nil) - URL currently in use by the portal.
  • defaultDomain (type: String.t, default: nil) - Default domain for the portal.
  • showSettings (type: boolean(), default: nil) - Not used by Apigee hybrid.
  • analyticsTrackingId (type: String.t, default: nil) -
  • id (type: String.t, default: nil) - ID of the portal.
  • migrationSrcSiteId (type: String.t, default: nil) - Not used by Apigee hybrid.
  • trashedOn (type: String.t, default: nil) - Time the portal was deleted in milliseconds since epoch.
  • trashed (type: boolean(), default: nil) - Boolean flag that specifies whether the portal has been deleted.
  • logoUrl (type: String.t, default: nil) - Logo image used on desktop devices.
  • currentDomain (type: String.t, default: nil) - Domain name currently in use by the portal.
  • fileLimit (type: integer(), default: nil) - Maximimum number of file assets that can be uploaded.
  • altLogoUrl (type: String.t, default: nil) - Logo image used on mobile devices.
  • migrationDestSiteId (type: String.t, default: nil) - Not used by Apigee hybrid.
  • https (type: boolean(), default: nil) - Boolean flag that specifies whether the URL will be HTTPS.
  • created (type: String.t, default: nil) - Time the portal was created in milliseconds since epoch.

Attributes

  • data (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SiteData.t), default: nil) - Details for the portals.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • authType (type: String.t, default: nil) - Authorization type. Valid values include SSL, TLS, or blank (no auth).
  • fromEmail (type: String.t, default: nil) - Email address used as the sender.
  • host (type: String.t, default: nil) - Host URL of the SMTP server.
  • id (type: integer(), default: nil) - ID of the SMTP configuration.
  • password (type: String.t, default: nil) - SMTP password.
  • port (type: String.t, default: nil) - Port number for the SMTP server. Supported values include: 465 (SSL), 587 (TLS), and 25 (open, no authorization).
  • secure (type: boolean(), default: nil) - Boolean flag that specifies whether to use a secure connection to the SMTP server.
  • securePassword (type: String.t, default: nil) - SMTP secure password.
  • siteId (type: String.t, default: nil) - ID of the portal.
  • username (type: String.t, default: nil) - SMTP username.

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SmtpConfig.t, default: nil) - Details for the SMTP configuration.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

This message type encapsulates a stats response

This message type encapsulates the environment wrapper

Attributes

  • data (type: String.t, default: nil) - Details of the operation.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Pub/Sub subscription of an environment.

Attributes

  • etag (type: String.t, default: nil) - Entity tag (ETag) used for optimistic concurrency control as a way to help prevent simultaneous updates from overwriting each other.

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1SystemStateData.t, default: nil) - Details of the system state.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Attributes

  • features (type: list(String.t), default: nil) - List of portal features.
  • systemAccessLevelMessage (type: String.t, default: nil) - System access level message.
  • systemAccessTtl (type: integer(), default: nil) - System access time-to-live (TTL).
  • systemStateAccessLevel (type: String.t, default: nil) - System access level.

TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.

Attributes

  • host (type: String.t, default: nil) - Target host name.
  • name (type: String.t, default: nil) - The target server revision name. Must be of the form 'organizations/{org}/environments/{env}/targetservers/{ts_id}/revisions/{rev}'.
  • port (type: integer(), default: nil) - Target port.
  • tlsInfo (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1TlsInfoConfig.t, default: nil) - TLS settings for the target.

Attributes

  • body (type: String.t, default: nil) - Body of the test email.
  • subject (type: String.t, default: nil) - Subject of the test email.

Attributes

  • defaultVariables (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomStyleConfig.t, default: nil) - Custom styles for the default variables.
  • schemaInfo (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomStyleSchemaInfo.t, default: nil) - Custom style details.

Attributes

  • customScss (type: String.t, default: nil) - Custom style overrides.
  • editorMode (type: String.t, default: nil) - Theme editor mode.
  • favicon (type: String.t, default: nil) - Favicon image (base64-encoded string).
  • kind (type: String.t, default: nil) - Set to "theme-editor-update".
  • logo (type: String.t, default: nil) - Desktop logo image (base64-encoded string).
  • mobileLogo (type: String.t, default: nil) - Mobile logo image (base64-encoded string).
  • overrides (type: String.t, default: nil) - Variable overrides.
  • variables (type: String.t, default: nil) - Basic style settings.

TLS configuration information for VirtualHosts and TargetServers.

Attributes

  • value (type: String.t, default: nil) - The TLS Common Name string of the certificate.
  • wildcardMatch (type: boolean(), default: nil) - Indicates whether the cert should be matched against as a wildcard cert.

Attributes

  • ciphers (type: list(String.t), default: nil) - Whitelist of supported ciphers.
  • clientAuthEnabled (type: boolean(), default: nil) - Indicates if client auth is enabled for the target. Enables two-way TLS.
  • commonName (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CommonNameConfig.t, default: nil) - Common name to validate the target against.
  • enabled (type: boolean(), default: nil) - Enables one-way TLS.
  • ignoreValidationErrors (type: boolean(), default: nil) - If true, ignore TLS certificate validation errors.
  • keyAlias (type: String.t, default: nil) - The name of the Alias used for client side auth. It must be of the form: organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}
  • keyAliasReference (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyAliasReference.t, default: nil) - A pair of reference name and alias to use for client side auth.
  • protocols (type: list(String.t), default: nil) - Whitelist of supported TLS protocols.
  • trustStore (type: String.t, default: nil) - The name of the Keystore or keystore reference containing trusted certificates for the server. It must be of either the form organizations/{org}/environments/{env}/keystores/{keystore} or organizations/{org}/environments/{env}/references/{reference}.

Attributes

  • cssEditorPayload (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CssEditorUpdatePayload.t, default: nil) -
  • themeEditorPayload (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ThemeEditorUpdatePayload.t, default: nil) -

Response message for the UpdateIdentityProviderCertificate RPC.

Response message for the UpdateIdentityProviderConfig RPC.

Response message for the UpdateIdentityProvider RPC.

Response message for the UpdateZone RPC.

Attributes

  • customFieldValues (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomFieldValue.t), default: nil) - List of custom fields and values.
  • email (type: String.t, default: nil) - Email address for user.
  • id (type: String.t, default: nil) - ID of user.
  • isActive (type: integer(), default: nil) - Flag that specifies whether user is active.
  • lastLogonTime (type: String.t, default: nil) - Time the user last signed in to the portal in milliseconds since epoch.
  • lastModified (type: String.t, default: nil) - Time the user was last modified in milliseconds since epoch.
  • name (type: String.t, default: nil) - Name of user.
  • password (type: String.t, default: nil) - Password for user.
  • verified (type: boolean(), default: nil) - Boolean flag that specifies whether the user account was verified.

Request message for the VerifyCertificate RPC.

Response message for the VerifyCertificate RPC.

Attributes

  • draftToken (type: String.t, default: nil) - Draft token.

Attributes

  • accountCreationEmail (type: String.t, default: nil) - Address to which notification emails are sent when a new account is created.
  • active (type: boolean(), default: nil) - Boolean flag that specifies whether the zone is active.
  • allowedDomains (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ZoneAllowedDomains.t, default: nil) - List of individual email addresses (developer@some-company.com) or email domains (some-company.com, without the leading @) that can create accounts on your portal.
  • companyName (type: String.t, default: nil) - Company associated with the zone.
  • copyright (type: String.t, default: nil) - Copyright information displayed on the sign in page for the zone to enable custom branding.
  • created (type: String.t, default: nil) - Time the zone was created in milliseconds since epoch.
  • customEmailTemplates (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ZoneCustomEmailTemplates.t, default: nil) - Email templates used by the zone. Email templates enable a user to customize the emails that are sent by a zone for different actions including: account verification, password reset, and account creation.
  • customRegistrationFields (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomRegistrationField.t), default: nil) - Customized fields used on user registration form.
  • description (type: String.t, default: nil) - Description of the zone.
  • footerLinks (type: map(), default: nil) - Mapping of display text to URL for forming hyperlinks used in the footer.
  • hostWhitelistedDomains (type: list(String.t), default: nil) - List of portal URLs that are allowed to use this zone for sign in and zone redirection after successful sign in. This list is used as a security measure so that the zone only redirects to a predefined set of URLs that are configured when the zone or portal is created, and when a custom domain is set on a portal.
  • id (type: String.t, default: nil) - ID of the zone.
  • links (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ZoneLinks.t, default: nil) - Links in the UI used by the zone.
  • manualApproval (type: boolean(), default: nil) - Boolean flag that specifies whether manual approval of users is required.
  • modified (type: String.t, default: nil) - Time the zone was last modified in milliseconds since epoch.
  • name (type: String.t, default: nil) - Name of the zone.
  • organization (type: String.t, default: nil) - Apigee organization associated with the zone.
  • portals (type: list(String.t), default: nil) - List of portals associated with the zone.
  • productLogo (type: String.t, default: nil) - Product logo PNG image (base64-encoded string).
  • samlConfig (type: map(), default: nil) - SAML configuration used by the zone.
  • smtpConfig (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ZoneSmtpConfig.t, default: nil) - SMTP configuration for the zone.
  • squareLogo (type: String.t, default: nil) - Product logo PNG image (base64-encoded string).
  • tokenPolicy (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ZoneTokenPolicy.t, default: nil) - Token policy for the zone.
  • zoneId (type: String.t, default: nil) - ID of the zone.

Attributes

  • whitelistedDomains (type: list(String.t), default: nil) - Individual email addresses (developer@some-company.com) or email domains (some-company.com, without the leading @) that can create accounts on your portal.

Attributes

  • audiencesEnabled (type: boolean(), default: nil) - Boolean flag that specifies whether the audience feature is enabled.
  • zmsId (type: String.t, default: nil) - ID of the zone.

Attributes

  • data (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ZoneAudienceEnabled.t, default: nil) - Audience feature flag setting for the zone.
  • errorCode (type: String.t, default: nil) - ID that can be used to find errors in the log files.
  • message (type: String.t, default: nil) - Description of the operation.
  • requestId (type: String.t, default: nil) - ID that can be used to find request details in the log files.
  • status (type: String.t, default: nil) - Status of the operation.

Links and information used when signing out of zone.

Attributes

  • passwd (type: String.t, default: nil) - Link in the UI to reset the password for the zone.
  • selfServiceLinksEnabled (type: boolean(), default: nil) - Boolean flag that specifies whether self-service links are enabled.
  • signup (type: String.t, default: nil) - Link in the UI to create an account in the zone.

Attributes

  • accessTokenValidity (type: String.t, default: nil) - Duration in seconds that the access token will be valid after it is created.
  • keys (type: map(), default: nil) - Keys used by the token policy.
  • refreshTokenValidity (type: String.t, default: nil) - Duration in seconds that the refresh token will be valid after it is created.

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.

Provides the configuration for logging a type of permissions. Example

Associates members with a role.

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

Request message for SetIamPolicy method.

Request message for TestIamPermissions method.

Response message for TestIamPermissions method.

The request message for Operations.CancelOperation.

The response message for Operations.ListOperations.

This resource represents a long-running operation that is the result of a network API call.

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

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. Each Status message contains three pieces of data: error code, error message, and error details.

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.