googleapis.apigee.v1 library

Classes

ApigeeApi
Use the Apigee API to programmatically develop and manage APIs with a set of RESTful operations. Develop and secure API proxies, deploy and undeploy API proxy revisions, monitor APIs, configure environments, manage users, and more. Get started using the APIs. Note: This product is available as a free trial for a time period of 60 days.
GoogleApiHttpBody
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. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
GoogleCloudApigeeV1Access
GoogleCloudApigeeV1AccessGet
Get action. For example, "Get" : { "name" : "target.name", "value" : "default" }
GoogleCloudApigeeV1AccessRemove
Remove action. For example, "Remove" : { "name" : "target.name", "success" : true }
GoogleCloudApigeeV1AccessSet
Set action. For example, "Set" : { "name" : "target.name", "success" : true, "value" : "default" }
GoogleCloudApigeeV1Alias
A reference to a certificate or key, certificate pair.
GoogleCloudApigeeV1AliasRevisionConfig
GoogleCloudApigeeV1ApiCategory
the Api category resource wrapped with response status, error_code etc.
GoogleCloudApigeeV1ApiCategoryData
the Api category resource.
GoogleCloudApigeeV1ApiProduct
GoogleCloudApigeeV1ApiProductRef
GoogleCloudApigeeV1ApiProxy
Metadata describing the API proxy
GoogleCloudApigeeV1ApiProxyRevision
API proxy revision.
GoogleCloudApigeeV1ApiResponseWrapper
GoogleCloudApigeeV1App
GoogleCloudApigeeV1AsyncQuery
GoogleCloudApigeeV1AsyncQueryResult
GoogleCloudApigeeV1Attribute
Key-value pair to store extra metadata.
GoogleCloudApigeeV1Attributes
GoogleCloudApigeeV1Certificate
GoogleCloudApigeeV1CertInfo
An X.509 certificate as defined in RFC 5280.
GoogleCloudApigeeV1CommonNameConfig
GoogleCloudApigeeV1ConfigVersion
Version of the API proxy configuration schema. Currently, only 4.0 is supported.
GoogleCloudApigeeV1Credential
GoogleCloudApigeeV1CustomReport
GoogleCloudApigeeV1CustomReportMetric
This encapsulates a metric property of the form sum(message_count) where name is message_count and function is sum
GoogleCloudApigeeV1DataCollectorConfig
Data collector and its configuration.
GoogleCloudApigeeV1Datastore
The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository.
GoogleCloudApigeeV1DatastoreConfig
Configuration detail for datastore
GoogleCloudApigeeV1DateRange
Date range of the data to export.
GoogleCloudApigeeV1DebugMask
GoogleCloudApigeeV1DebugSession
GoogleCloudApigeeV1DebugSessionTransaction
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.
GoogleCloudApigeeV1DeleteCustomReportResponse
GoogleCloudApigeeV1Deployment
GoogleCloudApigeeV1DeploymentChangeReport
Response for GenerateDeployChangeReport and GenerateUndeployChangeReport. This report contains any validation failures that would cause the deployment to be rejected, as well changes and conflicts in routing that may occur due to the new deployment. The existence of a routing warning does not necessarily imply that the deployment request is bad, if the desired state of the deployment request is to effect a routing change. The primary purposes of the routing messages are: 1) To inform users of routing changes that may have an effect on traffic currently being routed to other existing deployments. 2) To warn users if some basepath in the proxy will not receive traffic due to an existing deployment having already claimed that basepath. The presence of routing conflicts/changes will not cause non-dry-run DeployApiProxy/UndeployApiProxy requests to be rejected.
GoogleCloudApigeeV1DeploymentChangeReportRoutingChange
Describes a potential routing change that may occur as a result of some deployment operation.
GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict
Describes a routing conflict that may cause a deployment not to receive traffic at some basepath.
GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment
A tuple representing a basepath and the deployment containing it.
GoogleCloudApigeeV1DeploymentConfig
GoogleCloudApigeeV1Developer
GoogleCloudApigeeV1DeveloperApp
GoogleCloudApigeeV1DeveloperAppKey
GoogleCloudApigeeV1DimensionMetric
This message type encapsulates a metric grouped by dimension.
GoogleCloudApigeeV1EntityMetadata
Metadata common to many entities in this API.
GoogleCloudApigeeV1Environment
GoogleCloudApigeeV1EnvironmentConfig
GoogleCloudApigeeV1EnvironmentGroup
EnvironmentGroup configuration. An environment group is used to group one or more Apigee environments under a single host name.
GoogleCloudApigeeV1EnvironmentGroupAttachment
EnvironmentGroupAttachment is a resource which defines an attachment of an environment to an environment group.
GoogleCloudApigeeV1EnvironmentGroupConfig
EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup and its associated routing rules.
GoogleCloudApigeeV1Export
Details of an export job.
GoogleCloudApigeeV1ExportRequest
Request body for CreateExportRequest
GoogleCloudApigeeV1FlowHook
GoogleCloudApigeeV1FlowHookConfig
GoogleCloudApigeeV1GetSyncAuthorizationRequest
Request for GetSyncAuthorization.
GoogleCloudApigeeV1IngressConfig
GoogleCloudApigeeV1Instance
Apigee runtime instance.
GoogleCloudApigeeV1InstanceAttachment
InstanceAttachment represents the installation of an environment onto an instance.
GoogleCloudApigeeV1InstanceDeploymentStatus
The status of a deployment as reported by a single instance.
GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision
Revisions deployed in the MPs.
GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute
A route deployed in the ingress routing table.
GoogleCloudApigeeV1KeyAliasReference
GoogleCloudApigeeV1Keystore
A datastore for Certificates and Aliases
GoogleCloudApigeeV1KeystoreConfig
GoogleCloudApigeeV1KeyValueMap
A collection of key, value string pairs
GoogleCloudApigeeV1ListApiCategoriesResponse
the response for ListApiCategoriesRequest.
GoogleCloudApigeeV1ListApiProductsResponse
GoogleCloudApigeeV1ListApiProxiesResponse
GoogleCloudApigeeV1ListAppsResponse
GoogleCloudApigeeV1ListAsyncQueriesResponse
The response for ListAsyncQueries.
GoogleCloudApigeeV1ListCustomReportsResponse
This message encapsulates a list of custom report definitions
GoogleCloudApigeeV1ListDatastoresResponse
The response for ListDatastores
GoogleCloudApigeeV1ListDebugSessionsResponse
GoogleCloudApigeeV1ListDeploymentsResponse
GoogleCloudApigeeV1ListDeveloperAppsResponse
GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse
Response for ListEnvironmentGroupAttachments.
GoogleCloudApigeeV1ListEnvironmentGroupsResponse
Response for ListEnvironmentGroups.
GoogleCloudApigeeV1ListEnvironmentResourcesResponse
Response for ListEnvironmentResources
GoogleCloudApigeeV1ListExportsResponse
The response for ListExports
GoogleCloudApigeeV1ListHybridIssuersResponse
GoogleCloudApigeeV1ListInstanceAttachmentsResponse
Response for ListInstanceAttachments.
GoogleCloudApigeeV1ListInstancesResponse
Response for ListInstances.
GoogleCloudApigeeV1ListOfDevelopersResponse
GoogleCloudApigeeV1ListOrganizationsResponse
GoogleCloudApigeeV1ListSharedFlowsResponse
GoogleCloudApigeeV1Metadata
This message type encapsulates additional information about query execution.
GoogleCloudApigeeV1Metric
This message type encapsulates the metric data point. Example: { "name": "sum(message_count)", "values" : { "timestamp": 1549004400000, "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } } or { "name": "sum(message_count)", "values" : "39.0" }
GoogleCloudApigeeV1Operation
Operation represents the pairing of REST resource path and the actions (verbs) allowed on the resource path.
GoogleCloudApigeeV1OperationConfig
OperationConfig binds the resources in a proxy or remote service with the allowed REST methods and its associated quota enforcement.
GoogleCloudApigeeV1OperationGroup
The OperationGroup contains a list of configuration details associated with Apigee proxies or Remote services. Remote services are non-Apigee Edge proxies. eg, Istio-Envoy.
GoogleCloudApigeeV1OperationMetadata
Metadata describing an Operation.
GoogleCloudApigeeV1OptimizedStats
GoogleCloudApigeeV1OptimizedStatsNode
This message type encapsulates a data node as represented below: { "identifier": { "names": "apiproxy" , "values": "sirjee" }, "metric": [ { "env": "prod", "name": "sum(message_count)", "values": 36.0 } ] } OR { "env": "prod", "name": "sum(message_count)", "values": 36.0 } Depending on whether a dimension is present in the query or not the data node type can be a simple metric value or dimension identifier with list of metrics.
GoogleCloudApigeeV1OptimizedStatsResponse
This message type encapsulates a response format for Js Optimized Scenario.
GoogleCloudApigeeV1Organization
GoogleCloudApigeeV1OrganizationProjectMapping
GoogleCloudApigeeV1PodStatus
GoogleCloudApigeeV1Point
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: - Flow status debug points: StateChange FlowInfo Condition Execution DebugMask Error - Flow control debug points: FlowCallout Paused Resumed FlowReturn BreakFlow Error - Runtime debug points: ScriptExecutor FlowCalloutStepDefinition CustomTarget StepDefinition Oauth2ServicePoint RaiseFault NodeJS The detail information of the given debug point is stored in a list of results.
GoogleCloudApigeeV1Properties
Message for compatibility with legacy Edge specification for Java Properties object in JSON.
GoogleCloudApigeeV1Property
A single property entry in the Properties message.
GoogleCloudApigeeV1ProvisionOrganizationRequest
Request for ProvisionOrganization.
GoogleCloudApigeeV1Query
GoogleCloudApigeeV1QueryMetadata
GoogleCloudApigeeV1QueryMetric
More info about Metric: https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics
GoogleCloudApigeeV1Quota
Quota contains the essential parameters needed that can be applied on a proxy/remote service, resources and methods combination associated with this API product. While setting of Quota is optional, setting it prevents requests from exceeding the provisioned parameters.
GoogleCloudApigeeV1Reference
A Reference configuration. References must refer to a keystore that also exists in the parent environment.
GoogleCloudApigeeV1ReferenceConfig
GoogleCloudApigeeV1ReportInstanceStatusRequest
Request for ReportInstanceStatus.
GoogleCloudApigeeV1ReportInstanceStatusResponse
Placeholder for future enhancements to status reporting protocol
GoogleCloudApigeeV1ReportProperty
GoogleCloudApigeeV1ResourceConfig
GoogleCloudApigeeV1ResourceFile
Metadata about a resource file.
GoogleCloudApigeeV1ResourceFiles
List of resource files.
GoogleCloudApigeeV1ResourceStatus
The status of a resource loaded in the runtime.
GoogleCloudApigeeV1Result
Result is short for "action result", could be different types identified by "action_result" field. Supported types: 1. DebugInfo : generic debug info collected by runtime recorded as a list of properties. For example, the contents could be virtual host info, state change result, or execution metadata. Required fields : properties, timestamp 2. RequestMessage: information of a http request. Contains headers, request URI and http methods type.Required fields : headers, uri, verb 3. ResponseMessage: information of a http response. Contains headers, reason phrase and http status code. Required fields : headers, reasonPhrase, statusCode 4. ErrorMessage: information of a http error message. Contains detail error message, reason phrase and status code. Required fields : content, headers, reasonPhrase, statusCode 5. VariableAccess: a list of variable access actions, can be Get, Set and Remove. Required fields : accessList
GoogleCloudApigeeV1RevisionStatus
The status of a specific resource revision.
GoogleCloudApigeeV1RoutingRule
GoogleCloudApigeeV1RuntimeTraceConfig
NEXT ID: 8 RuntimeTraceConfig defines the configurations for distributed trace in an environment.
GoogleCloudApigeeV1RuntimeTraceConfigOverride
NEXT ID: 7 Trace configuration override for a specific API proxy in an environment.
GoogleCloudApigeeV1RuntimeTraceSamplingConfig
NEXT ID: 6 RuntimeTraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs.
GoogleCloudApigeeV1RuntimeTraceSamplingConfigResponseCodeRange
ResponseCodeRange represents a group of response codes to capture, from the first response code to the last response code. Each range is a close interval. For example, if an interval is 400, 403, then that means 400, 401, 402, 403 will be all captured.
GoogleCloudApigeeV1Schema
Response for Schema call
GoogleCloudApigeeV1SchemaSchemaElement
Message type for the schema element
GoogleCloudApigeeV1SchemaSchemaProperty
Message type for schema property
GoogleCloudApigeeV1ServiceIssuersMapping
GoogleCloudApigeeV1Session
Session carries the debug session id and its creation time.
GoogleCloudApigeeV1SharedFlow
The metadata describing a shared flow
GoogleCloudApigeeV1SharedFlowRevision
The metadata describing a shared flow revision.
GoogleCloudApigeeV1Stats
This message type encapsulates a stats response.
GoogleCloudApigeeV1StatsEnvironmentStats
This message type encapsulates the environment wrapper: "environments": [ { "metrics": [ { "name": "sum(message_count)", "values": "2.52056245E8" } ], "name": "prod" } ]
GoogleCloudApigeeV1Subscription
Pub/Sub subscription of an environment.
GoogleCloudApigeeV1SyncAuthorization
GoogleCloudApigeeV1TargetServer
TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
GoogleCloudApigeeV1TargetServerConfig
GoogleCloudApigeeV1TestDatastoreResponse
The response for TestDatastore
GoogleCloudApigeeV1TlsInfo
TLS configuration information for VirtualHosts and TargetServers.
GoogleCloudApigeeV1TlsInfoCommonName
GoogleCloudApigeeV1TlsInfoConfig
GoogleCloudApigeeV1UpdateError
Details on why a resource update failed in the runtime.
GoogleIamV1AuditConfig
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. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": "user:aliya@example.com" } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
GoogleIamV1AuditLogConfig
Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
GoogleIamV1Binding
Associates members with a role.
GoogleIamV1Policy
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" }, { "role": "roles/resourcemanager.organizationViewer", "members": "user:eve@example.com" , "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the IAM documentation.
GoogleIamV1SetIamPolicyRequest
Request message for SetIamPolicy method.
GoogleIamV1TestIamPermissionsRequest
Request message for TestIamPermissions method.
GoogleIamV1TestIamPermissionsResponse
Response message for TestIamPermissions method.
GoogleLongrunningListOperationsResponse
The response message for Operations.ListOperations.
GoogleLongrunningOperation
This resource represents a long-running operation that is the result of a network API call.
GoogleProtobufEmpty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.
GoogleRpcPreconditionFailure
Describes what preconditions have failed. For example, if an RPC failed because it required the Terms of Service to be acknowledged, it could list the terms of service violation in the PreconditionFailure message.
GoogleRpcPreconditionFailureViolation
A message type used to describe a single precondition failure.
GoogleRpcStatus
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. You can find out more about this error model and how to work with it in the API Design Guide.
GoogleTypeExpr
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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
HybridIssuersResourceApi
HybridResourceApi
OrganizationsAnalyticsDatastoresResourceApi
OrganizationsAnalyticsResourceApi
OrganizationsApiproductsAttributesResourceApi
OrganizationsApiproductsResourceApi
OrganizationsApisDeploymentsResourceApi
OrganizationsApisKeyvaluemapsResourceApi
OrganizationsApisResourceApi
OrganizationsApisRevisionsDeploymentsResourceApi
OrganizationsApisRevisionsResourceApi
OrganizationsAppsResourceApi
OrganizationsDeploymentsResourceApi
OrganizationsDevelopersAppsAttributesResourceApi
OrganizationsDevelopersAppsKeysApiproductsResourceApi
OrganizationsDevelopersAppsKeysCreateResourceApi
OrganizationsDevelopersAppsKeysResourceApi
OrganizationsDevelopersAppsResourceApi
OrganizationsDevelopersAttributesResourceApi
OrganizationsDevelopersResourceApi
OrganizationsEnvgroupsAttachmentsResourceApi
OrganizationsEnvgroupsResourceApi
OrganizationsEnvironmentsAnalyticsAdminResourceApi
OrganizationsEnvironmentsAnalyticsExportsResourceApi
OrganizationsEnvironmentsAnalyticsResourceApi
OrganizationsEnvironmentsApisDeploymentsResourceApi
OrganizationsEnvironmentsApisResourceApi
OrganizationsEnvironmentsApisRevisionsDebugsessionsDataResourceApi
OrganizationsEnvironmentsApisRevisionsDebugsessionsResourceApi
OrganizationsEnvironmentsApisRevisionsDeploymentsResourceApi
OrganizationsEnvironmentsApisRevisionsResourceApi
OrganizationsEnvironmentsCachesResourceApi
OrganizationsEnvironmentsDeploymentsResourceApi
OrganizationsEnvironmentsFlowhooksResourceApi
OrganizationsEnvironmentsKeystoresAliasesResourceApi
OrganizationsEnvironmentsKeystoresResourceApi
OrganizationsEnvironmentsKeyvaluemapsResourceApi
OrganizationsEnvironmentsOptimizedStatsResourceApi
OrganizationsEnvironmentsQueriesResourceApi
OrganizationsEnvironmentsReferencesResourceApi
OrganizationsEnvironmentsResourceApi
OrganizationsEnvironmentsResourcefilesResourceApi
OrganizationsEnvironmentsSharedflowsDeploymentsResourceApi
OrganizationsEnvironmentsSharedflowsResourceApi
OrganizationsEnvironmentsSharedflowsRevisionsResourceApi
OrganizationsEnvironmentsStatsResourceApi
OrganizationsEnvironmentsTargetserversResourceApi
OrganizationsInstancesAttachmentsResourceApi
OrganizationsInstancesResourceApi
OrganizationsKeyvaluemapsResourceApi
OrganizationsOperationsResourceApi
OrganizationsReportsResourceApi
OrganizationsResourceApi
OrganizationsSharedflowsDeploymentsResourceApi
OrganizationsSharedflowsResourceApi
OrganizationsSharedflowsRevisionsDeploymentsResourceApi
OrganizationsSharedflowsRevisionsResourceApi
OrganizationsSitesApicategoriesResourceApi
OrganizationsSitesResourceApi
ProjectsResourceApi

Constants

USER_AGENT → const String
'dart-api-client apigee/v1'

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.