google_api_apigee v0.7.0 API Reference
Modules
API client metadata for GoogleApi.Apigee.V1.
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
) -
Metadata describing the API proxy
API proxy revision.
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: keyExpiresInlastModifiedAt
(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.
Key-value pair to store extra metadata.
An X.509 certificate as defined in RFC 5280.
Version of the API proxy configuration schema. Currently, only 4.0 is supported.
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
chartType
(type:String.t
, default:nil
) - This field contains the chart type for the reportcomments
(type:list(String.t)
, default:nil
) - Legacy field: not used. This field contains a list of comments associated with custom reportcreatedAt
(type:String.t
, default:nil
) - Output only. Unix time when the app was created json key: createdAtdimensions
(type:list(String.t)
, default:nil
) - This contains the list of dimensions for the reportdisplayName
(type:String.t
, default:nil
) - This is the display name for the reportenvironment
(type:String.t
, default:nil
) - Output only. Environment namefilter
(type:String.t
, default:nil
) - This field contains the filter expressionfromTime
(type:String.t
, default:nil
) - Legacy field: not used. Contains the from time for the reportlastModifiedAt
(type:String.t
, default:nil
) - Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAtlastViewedAt
(type:String.t
, default:nil
) - Output only. Last viewed time of this entity as milliseconds since epochlimit
(type:String.t
, default:nil
) - Legacy field: not used This field contains the limit for the result retrievedmetrics
(type:list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomReportMetric.t)
, default:nil
) - Required. This contains the list of metricsname
(type:String.t
, default:nil
) - Required. Unique identifier for the report T his is a legacy field used to encode custom report unique idoffset
(type:String.t
, default:nil
) - Legacy field: not used. This field contains the offset for the dataorganization
(type:String.t
, default:nil
) - Output only. Organization nameproperties
(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 columnssortOrder
(type:String.t
, default:nil
) - Legacy field: not used much. Contains the sort order for the sort columnstags
(type:list(String.t)
, default:nil
) - Legacy field: not used. This field contains a list of tags associated with custom reporttimeUnit
(type:String.t
, default:nil
) - This field contains the time unit of aggregation for the reporttoTime
(type:String.t
, default:nil
) - Legacy field: not used. Contains the end time for the reporttopk
(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
faultJSONPaths
(type:list(String.t)
, default:nil
) - List of JSON paths that specify the JSON elements to be filtered from JSON payloads in error flows.faultXPaths
(type:list(String.t)
, default:nil
) - List of XPaths that specify the XML elements to be filtered from XML payloads in error flows.name
(type:String.t
, default:nil
) - Name of the debug mask.namespaces
(type:map()
, default:nil
) - Map of namespaces to URIs.requestJSONPaths
(type:list(String.t)
, default:nil
) - List of JSON paths that specify the JSON elements to be filtered from JSON request message payloads.requestXPaths
(type:list(String.t)
, default:nil
) - List of XPaths that specify the XML elements to be filtered from XML request message payloads.responseJSONPaths
(type:list(String.t)
, default:nil
) - List of JSON paths that specify the JSON elements to be filtered from JSON response message payloads.responseXPaths
(type:list(String.t)
, default:nil
) - List of XPaths that specify the 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 the 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
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 markeddeployed
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
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 includeapproved
orrevoked
.
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 includeapproved
orrevoked
.
This message type encapsulates a metric grouped by dimension
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 environmentfeatureFlags
(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
continueOnError
(type:boolean()
, default:nil
) - Optional. Flag that specifies whether execution should continue if the flow hook throws an exception. Set totrue
to continue execution. Set tofalse
to stop execution if the flow hook throws an exception.Defaults totrue
.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 ofPreProxyFlowHook
,PostProxyFlowHook
,PreTargetFlowHook
, orPostTargetFlowHook
.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 PostTargetFlowHooksharedFlowName
(type:String.t
, default:nil
) - The name of the shared flow to invoke. Must be of the form 'organizations/{org}/sharedflows/{sharedflow}'.
Request for GetSyncAuthorization.
A collection of key, value string pairs
A datastore for Certificates and Aliases
The response for ListAsyncQueries
This message encapsulates a list of custom report definitions
Response for ListEnvironmentResources
This message type encapsulates additional information about query execution
This message type encapsulates the metric data point Example { "name": "sum(message_count)", "values" : [ {
Metadata describing an Operation.
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.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.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
) - Output only. 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.
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
Message for compatibility with legacy Edge specification for Java Properties object in JSON.
A single property entry in the Properties message.
Attributes
csvDelimiter
(type:String.t
, default:nil
) - Delimiter used in the CSV file, ifoutputFormat
is set tocsv
. 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#dimensionsfilter
(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-syntaxgroupByTimeUnit
(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 Metricsname
(type:String.t
, default:nil
) - Asynchronous Query Name.outputFormat
(type:String.t
, default:nil
) - Valid values include:csv
orjson
. Defaults tojson
. 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.
More info about Metric: https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics
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
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}'.
Metadata about a resource file.
List of resource files.
Result is short for "action result", could be different types identified by "action_result" field. Supported types
Response for Schema call
Message type for the schema element
Message type for schema property
Session carries the debug session id and its creation time.
The metadata describing a shared flow
The metadata describing a shared flow revision.
This message type encapsulates a stats response
This message type encapsulates the environment wrapper
Pub/Sub subscription of an environment.
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.
TLS configuration information for VirtualHosts and TargetServers.
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}.
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 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.