Returns the analytics Resource.
Returns the apiproducts Resource.
Returns the apis Resource.
Returns the apps Resource.
Returns the deployments Resource.
Returns the developers Resource.
Returns the envgroups Resource.
Returns the environments Resource.
Returns the instances Resource.
Returns the keyvaluemaps Resource.
Returns the operations Resource.
Returns the reports Resource.
Returns the sharedflows Resource.
Close httplib2 connections.
create(body=None, parent=None, x__xgafv=None)
Creates an Apigee organization. See [Create an Apigee organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org).
Gets the profile for an Apigee organization. See [Understanding organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure).
getDeployedIngressConfig(name, x__xgafv=None)
Gets the deployed ingress configuration for an organization.
getSyncAuthorization(name, body=None, x__xgafv=None)
Lists the service accounts with the permissions required to allow the Synchronizer to download environment data from the control plane. An ETag is returned in the response to `getSyncAuthorization`. Pass that ETag when calling [setSyncAuthorization](setSyncAuthorization) to ensure that you are updating the correct version. If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. For more information, see [Configure the Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). **Note**: Available to Apigee hybrid only.
Lists the Apigee organizations and associated GCP projects that you have permission to access. See [Understanding organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure).
setSyncAuthorization(name, body=None, x__xgafv=None)
Sets the permissions required to allow the Synchronizer to download environment data from the control plane. You must call this API to enable proper functioning of hybrid. Pass the ETag when calling `setSyncAuthorization` to ensure that you are updating the correct version. To get an ETag, call [getSyncAuthorization](getSyncAuthorization). If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. For more information, see [Configure the Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). **Note**: Available to Apigee hybrid only.
update(name, body=None, x__xgafv=None)
Updates the properties for an Apigee organization. No other fields in the organization profile will be updated.
close()
Close httplib2 connections.
create(body=None, parent=None, x__xgafv=None)
Creates an Apigee organization. See [Create an Apigee organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org).
Args:
body: object, The request body.
The object takes the form of:
{
"name": "A String", # Output only. Name of the Apigee organization.
"customerName": "A String", # Not used by Apigee.
"type": "A String", # Not used by Apigee.
"attributes": [ # Not used by Apigee.
"A String",
],
"createdAt": "A String", # Output only. Time that the Apigee organization was created in milliseconds since epoch.
"subscriptionType": "A String", # 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](https://cloud.google.com/apigee/pricing/).
"analyticsRegion": "A String", # Required. Primary GCP region for analytics data storage. For valid values, see [Create an Apigee organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org).
"authorizedNetwork": "A String", # Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See [Getting started with the Service Networking API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). Valid only when [RuntimeType] is set to CLOUD. The value can be updated only when there are no runtime instances. For example: "default". **Note:** Not supported for Apigee hybrid.
"environments": [ # Output only. List of environments in the Apigee organization.
"A String",
],
"runtimeType": "A String", # Required. Runtime type of the Apigee organization based on the Apigee subscription purchased.
"displayName": "A String",
"description": "A String", # Description of the Apigee organization.
"projectId": "A String", # The project ID associated with the Apigee organization.
"caCertificate": "A String", # Output only. Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when [RuntimeType] is CLOUD.
"lastModifiedAt": "A String", # Output only. Time that the Apigee organization was last modified in milliseconds since epoch.
"properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Properties defined in the Apigee organization profile.
"property": [ # List of all properties in the object
{ # A single property entry in the Properties message.
"name": "A String", # The property key
"value": "A String", # The property value
},
],
},
}
parent: string, Required. Name of the GCP project in which to associate the Apigee organization. Pass the information as a query parameter using the following structure in your request: `projects/`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
}
get(name, x__xgafv=None)
Gets the profile for an Apigee organization. See [Understanding organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure).
Args:
name: string, Required. Apigee organization name in the following format: `organizations/{org}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"name": "A String", # Output only. Name of the Apigee organization.
"customerName": "A String", # Not used by Apigee.
"type": "A String", # Not used by Apigee.
"attributes": [ # Not used by Apigee.
"A String",
],
"createdAt": "A String", # Output only. Time that the Apigee organization was created in milliseconds since epoch.
"subscriptionType": "A String", # 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](https://cloud.google.com/apigee/pricing/).
"analyticsRegion": "A String", # Required. Primary GCP region for analytics data storage. For valid values, see [Create an Apigee organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org).
"authorizedNetwork": "A String", # Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See [Getting started with the Service Networking API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). Valid only when [RuntimeType] is set to CLOUD. The value can be updated only when there are no runtime instances. For example: "default". **Note:** Not supported for Apigee hybrid.
"environments": [ # Output only. List of environments in the Apigee organization.
"A String",
],
"runtimeType": "A String", # Required. Runtime type of the Apigee organization based on the Apigee subscription purchased.
"displayName": "A String",
"description": "A String", # Description of the Apigee organization.
"projectId": "A String", # The project ID associated with the Apigee organization.
"caCertificate": "A String", # Output only. Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when [RuntimeType] is CLOUD.
"lastModifiedAt": "A String", # Output only. Time that the Apigee organization was last modified in milliseconds since epoch.
"properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Properties defined in the Apigee organization profile.
"property": [ # List of all properties in the object
{ # A single property entry in the Properties message.
"name": "A String", # The property key
"value": "A String", # The property value
},
],
},
}
getDeployedIngressConfig(name, x__xgafv=None)
Gets the deployed ingress configuration for an organization.
Args:
name: string, Required. Name of the deployed configuration for the organization in the following format: 'organizations/{org}/deployedIngressConfig'. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"name": "A String", # Name of the resource in the following format: `organizations/{org}/deployedIngressConfig`.
"uid": "A String", # A unique id for the ingress config that will only change if the organization is deleted and recreated.
"revisionId": "A String", # Revision id that defines the ordering on IngressConfig resources. The higher the revision, the more recently the configuration was deployed.
"revisionCreateTime": "A String", # Time at which the IngressConfig revision was created.
"environmentGroups": [ # List of environment groups in the organization.
{ # EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup and its associated routing rules.
"revisionId": "A String", # Revision id that defines the ordering of the EnvironmentGroupConfig resource. The higher the revision, the more recently the configuration was deployed.
"hostnames": [ # Host names for the environment group.
"A String",
],
"routingRules": [ # Ordered list of routing rules defining how traffic to this environment group's hostnames should be routed to different environments.
{
"environment": "A String", # Name of an environment bound to the environment group in the following format: `organizations/{org}/environments/{env}`.
"basepath": "A String", # URI path prefix used to route to the specified environment. May contain one or more wildcards. For example, path segments consisting of a single `*` character will match any string.
},
],
"uid": "A String", # A unique id for the environment group config that will only change if the environment group is deleted and recreated.
"name": "A String", # Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`.
},
],
}
getSyncAuthorization(name, body=None, x__xgafv=None)
Lists the service accounts with the permissions required to allow the Synchronizer to download environment data from the control plane. An ETag is returned in the response to `getSyncAuthorization`. Pass that ETag when calling [setSyncAuthorization](setSyncAuthorization) to ensure that you are updating the correct version. If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. For more information, see [Configure the Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). **Note**: Available to Apigee hybrid only.
Args:
name: string, Required. Name of the Apigee organization. Use the following structure in your request: `organizations/{org}` (required)
body: object, The request body.
The object takes the form of:
{ # Request for GetSyncAuthorization.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"identities": [ # Required. Array of service accounts to grant access to control plane resources, each specified using the following format: `serviceAccount:` service-account-name. The service-account-name is formatted like an email address. For example: `my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com` You might specify multiple service accounts, for example, if you have multiple environments and wish to assign a unique service account to each one. The service accounts must have **Apigee Synchronizer Manager** role. See also [Create service accounts](https://cloud.google.com/apigee/docs/hybrid/latest/sa-about#create-the-service-accounts).
"A String",
],
"etag": "A String", # Entity tag (ETag) used for optimistic concurrency control as a way to help prevent simultaneous updates from overwriting each other. For example, when you call [getSyncAuthorization](getSyncAuthorization) an ETag is returned in the response. Pass that ETag when calling the [setSyncAuthorization](setSyncAuthorization) to ensure that you are updating the correct version. If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. **Note**: We strongly recommend that you use the ETag in the read-modify-write cycle to avoid race conditions.
}
list(parent, x__xgafv=None)
Lists the Apigee organizations and associated GCP projects that you have permission to access. See [Understanding organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure).
Args:
parent: string, Required. Use the following structure in your request: `organizations` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"organizations": [ # List of Apigee organizations and associated GCP projects.
{
"projectIds": [ # List of GCP projects associated with the Apigee organization.
"A String",
],
"organization": "A String", # Name of the Apigee organization.
},
],
}
setSyncAuthorization(name, body=None, x__xgafv=None)
Sets the permissions required to allow the Synchronizer to download environment data from the control plane. You must call this API to enable proper functioning of hybrid. Pass the ETag when calling `setSyncAuthorization` to ensure that you are updating the correct version. To get an ETag, call [getSyncAuthorization](getSyncAuthorization). If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. For more information, see [Configure the Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). **Note**: Available to Apigee hybrid only.
Args:
name: string, Required. Name of the Apigee organization. Use the following structure in your request: `organizations/{org}` (required)
body: object, The request body.
The object takes the form of:
{
"identities": [ # Required. Array of service accounts to grant access to control plane resources, each specified using the following format: `serviceAccount:` service-account-name. The service-account-name is formatted like an email address. For example: `my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com` You might specify multiple service accounts, for example, if you have multiple environments and wish to assign a unique service account to each one. The service accounts must have **Apigee Synchronizer Manager** role. See also [Create service accounts](https://cloud.google.com/apigee/docs/hybrid/latest/sa-about#create-the-service-accounts).
"A String",
],
"etag": "A String", # Entity tag (ETag) used for optimistic concurrency control as a way to help prevent simultaneous updates from overwriting each other. For example, when you call [getSyncAuthorization](getSyncAuthorization) an ETag is returned in the response. Pass that ETag when calling the [setSyncAuthorization](setSyncAuthorization) to ensure that you are updating the correct version. If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. **Note**: We strongly recommend that you use the ETag in the read-modify-write cycle to avoid race conditions.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"identities": [ # Required. Array of service accounts to grant access to control plane resources, each specified using the following format: `serviceAccount:` service-account-name. The service-account-name is formatted like an email address. For example: `my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com` You might specify multiple service accounts, for example, if you have multiple environments and wish to assign a unique service account to each one. The service accounts must have **Apigee Synchronizer Manager** role. See also [Create service accounts](https://cloud.google.com/apigee/docs/hybrid/latest/sa-about#create-the-service-accounts).
"A String",
],
"etag": "A String", # Entity tag (ETag) used for optimistic concurrency control as a way to help prevent simultaneous updates from overwriting each other. For example, when you call [getSyncAuthorization](getSyncAuthorization) an ETag is returned in the response. Pass that ETag when calling the [setSyncAuthorization](setSyncAuthorization) to ensure that you are updating the correct version. If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. **Note**: We strongly recommend that you use the ETag in the read-modify-write cycle to avoid race conditions.
}
update(name, body=None, x__xgafv=None)
Updates the properties for an Apigee organization. No other fields in the organization profile will be updated.
Args:
name: string, Required. Apigee organization name in the following format: `organizations/{org}` (required)
body: object, The request body.
The object takes the form of:
{
"name": "A String", # Output only. Name of the Apigee organization.
"customerName": "A String", # Not used by Apigee.
"type": "A String", # Not used by Apigee.
"attributes": [ # Not used by Apigee.
"A String",
],
"createdAt": "A String", # Output only. Time that the Apigee organization was created in milliseconds since epoch.
"subscriptionType": "A String", # 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](https://cloud.google.com/apigee/pricing/).
"analyticsRegion": "A String", # Required. Primary GCP region for analytics data storage. For valid values, see [Create an Apigee organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org).
"authorizedNetwork": "A String", # Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See [Getting started with the Service Networking API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). Valid only when [RuntimeType] is set to CLOUD. The value can be updated only when there are no runtime instances. For example: "default". **Note:** Not supported for Apigee hybrid.
"environments": [ # Output only. List of environments in the Apigee organization.
"A String",
],
"runtimeType": "A String", # Required. Runtime type of the Apigee organization based on the Apigee subscription purchased.
"displayName": "A String",
"description": "A String", # Description of the Apigee organization.
"projectId": "A String", # The project ID associated with the Apigee organization.
"caCertificate": "A String", # Output only. Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when [RuntimeType] is CLOUD.
"lastModifiedAt": "A String", # Output only. Time that the Apigee organization was last modified in milliseconds since epoch.
"properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Properties defined in the Apigee organization profile.
"property": [ # List of all properties in the object
{ # A single property entry in the Properties message.
"name": "A String", # The property key
"value": "A String", # The property value
},
],
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"name": "A String", # Output only. Name of the Apigee organization.
"customerName": "A String", # Not used by Apigee.
"type": "A String", # Not used by Apigee.
"attributes": [ # Not used by Apigee.
"A String",
],
"createdAt": "A String", # Output only. Time that the Apigee organization was created in milliseconds since epoch.
"subscriptionType": "A String", # 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](https://cloud.google.com/apigee/pricing/).
"analyticsRegion": "A String", # Required. Primary GCP region for analytics data storage. For valid values, see [Create an Apigee organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org).
"authorizedNetwork": "A String", # Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See [Getting started with the Service Networking API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). Valid only when [RuntimeType] is set to CLOUD. The value can be updated only when there are no runtime instances. For example: "default". **Note:** Not supported for Apigee hybrid.
"environments": [ # Output only. List of environments in the Apigee organization.
"A String",
],
"runtimeType": "A String", # Required. Runtime type of the Apigee organization based on the Apigee subscription purchased.
"displayName": "A String",
"description": "A String", # Description of the Apigee organization.
"projectId": "A String", # The project ID associated with the Apigee organization.
"caCertificate": "A String", # Output only. Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when [RuntimeType] is CLOUD.
"lastModifiedAt": "A String", # Output only. Time that the Apigee organization was last modified in milliseconds since epoch.
"properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Properties defined in the Apigee organization profile.
"property": [ # List of all properties in the object
{ # A single property entry in the Properties message.
"name": "A String", # The property key
"value": "A String", # The property value
},
],
},
}