apigee

package
v1.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 23, 2022 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Copyright 2022 Google LLC. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Package apigee contains methods and types for handling apigee GCP resources.

Copyright 2022 Google LLC. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 Google LLC. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 Google LLC. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Package apigee defines operations in the declarative SDK.

Copyright 2022 Google LLC. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 Google LLC. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 Google LLC. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 Google LLC. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 Google LLC. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 Google LLC. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 Google LLC. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 Google LLC. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

Constants

View Source 
const AttachmentMaxPage = -1
View Source 
const EnvgroupMaxPage = -1
View Source 
const EnvironmentMaxPage = -1
View Source 
const InstanceMaxPage = -1
View Source 
const OrganizationMaxPage = -1

Variables

View Source 
var YAML_attachment = []byte("info:\n  title: Apigee/Attachment\n  description: The Apigee Attachment resource\n  x-dcl-struct-name: Attachment\n  x-dcl-has-iam: false\npaths:\n  get:\n    description: The function used to get information about a Attachment\n    parameters:\n    - name: Attachment\n      required: true\n      description: A full instance of a Attachment\n  apply:\n    description: The function used to apply information about a Attachment\n    parameters:\n    - name: Attachment\n      required: true\n      description: A full instance of a Attachment\n  delete:\n    description: The function used to delete a Attachment\n    parameters:\n    - name: Attachment\n      required: true\n      description: A full instance of a Attachment\n  deleteAll:\n    description: The function used to delete all Attachment\n    parameters:\n    - name: envgroup\n      required: true\n      schema:\n        type: string\n  list:\n    description: The function used to list information about many Attachment\n    parameters:\n    - name: envgroup\n      required: true\n      schema:\n        type: string\ncomponents:\n  schemas:\n    Attachment:\n      title: Attachment\n      x-dcl-id: '{{envgroup}}/attachments/{{name}}'\n      x-dcl-has-iam: false\n      type: object\n      required:\n      - environment\n      - envgroup\n      properties:\n        createdAt:\n          type: integer\n          format: int64\n          x-dcl-go-name: CreatedAt\n          readOnly: true\n          x-kubernetes-immutable: true\n        envgroup:\n          type: string\n          x-dcl-go-name: Envgroup\n          description: The envgroup for the resource\n          x-kubernetes-immutable: true\n          x-dcl-forward-slash-allowed: true\n          x-dcl-references:\n          - resource: Apigee/Envgroup\n            field: name\n            parent: true\n        environment:\n          type: string\n          x-dcl-go-name: Environment\n          description: Required. ID of the attached environment.\n          x-kubernetes-immutable: true\n          x-dcl-references:\n          - resource: Apigee/Environment\n            field: name\n        name:\n          type: string\n          x-dcl-go-name: Name\n          description: ID of the environment group attachment.\n          x-kubernetes-immutable: true\n          x-dcl-server-generated-parameter: true\n")

blaze-out/k8-fastbuild/genfiles/cloud/graphite/mmv2/services/google/apigee/attachment.yaml

View Source 
var YAML_envgroup = []byte("info:\n  title: Apigee/Envgroup\n  description: The Apigee Envgroup resource\n  x-dcl-struct-name: Envgroup\n  x-dcl-has-iam: false\npaths:\n  get:\n    description: The function used to get information about a Envgroup\n    parameters:\n    - name: Envgroup\n      required: true\n      description: A full instance of a Envgroup\n  apply:\n    description: The function used to apply information about a Envgroup\n    parameters:\n    - name: Envgroup\n      required: true\n      description: A full instance of a Envgroup\n  delete:\n    description: The function used to delete a Envgroup\n    parameters:\n    - name: Envgroup\n      required: true\n      description: A full instance of a Envgroup\n  deleteAll:\n    description: The function used to delete all Envgroup\n    parameters:\n    - name: apigeeorganization\n      required: true\n      schema:\n        type: string\n  list:\n    description: The function used to list information about many Envgroup\n    parameters:\n    - name: apigeeorganization\n      required: true\n      schema:\n        type: string\ncomponents:\n  schemas:\n    Envgroup:\n      title: Envgroup\n      x-dcl-id: organizations/{{apigee_organization}}/envgroups/{{name}}\n      x-dcl-has-iam: false\n      type: object\n      required:\n      - hostnames\n      - apigeeOrganization\n      properties:\n        apigeeOrganization:\n          type: string\n          x-dcl-go-name: ApigeeOrganization\n          description: The apigee organization for the resource\n          x-kubernetes-immutable: true\n          x-dcl-references:\n          - resource: Apigee/Organization\n            field: name\n            parent: true\n        createdAt:\n          type: integer\n          format: int64\n          x-dcl-go-name: CreatedAt\n          readOnly: true\n          x-kubernetes-immutable: true\n        hostnames:\n          type: array\n          x-dcl-go-name: Hostnames\n          description: Required. Host names for this environment group.\n          x-dcl-send-empty: true\n          x-dcl-list-type: list\n          items:\n            type: string\n            x-dcl-go-type: string\n        lastModifiedAt:\n          type: integer\n          format: int64\n          x-dcl-go-name: LastModifiedAt\n          readOnly: true\n          x-kubernetes-immutable: true\n        name:\n          type: string\n          x-dcl-go-name: Name\n          description: ID of the environment group.\n          x-kubernetes-immutable: true\n        state:\n          type: string\n          x-dcl-go-name: State\n          x-dcl-go-type: EnvgroupStateEnum\n          readOnly: true\n          description: 'Output only. State of the environment. Values other than ACTIVE\n            means the resource is not ready to use. Possible values: STATE_UNSPECIFIED,\n            CREATING, ACTIVE, DELETING'\n          x-kubernetes-immutable: true\n          enum:\n          - STATE_UNSPECIFIED\n          - CREATING\n          - ACTIVE\n          - DELETING\n")

blaze-out/k8-fastbuild/genfiles/cloud/graphite/mmv2/services/google/apigee/envgroup.yaml

View Source 
var YAML_environment = []byte("info:\n  title: Apigee/Environment\n  description: The Apigee Environment resource\n  x-dcl-struct-name: Environment\n  x-dcl-has-iam: true\npaths:\n  get:\n    description: The function used to get information about a Environment\n    parameters:\n    - name: Environment\n      required: true\n      description: A full instance of a Environment\n  apply:\n    description: The function used to apply information about a Environment\n    parameters:\n    - name: Environment\n      required: true\n      description: A full instance of a Environment\n  delete:\n    description: The function used to delete a Environment\n    parameters:\n    - name: Environment\n      required: true\n      description: A full instance of a Environment\n  deleteAll:\n    description: The function used to delete all Environment\n    parameters:\n    - name: apigeeorganization\n      required: true\n      schema:\n        type: string\n  list:\n    description: The function used to list information about many Environment\n    parameters:\n    - name: apigeeorganization\n      required: true\n      schema:\n        type: string\ncomponents:\n  schemas:\n    Environment:\n      title: Environment\n      x-dcl-id: organizations/{{apigee_organization}}/environments/{{name}}\n      x-dcl-has-iam: true\n      type: object\n      required:\n      - name\n      - apigeeOrganization\n      properties:\n        apigeeOrganization:\n          type: string\n          x-dcl-go-name: ApigeeOrganization\n          description: The apigee organization for the resource\n          x-kubernetes-immutable: true\n          x-dcl-references:\n          - resource: Apigee/Organization\n            field: name\n            parent: true\n        createdAt:\n          type: integer\n          format: int64\n          x-dcl-go-name: CreatedAt\n          readOnly: true\n          description: Output only. Creation time of this environment as milliseconds\n            since epoch.\n          x-kubernetes-immutable: true\n        description:\n          type: string\n          x-dcl-go-name: Description\n          description: Optional. Description of the environment.\n        displayName:\n          type: string\n          x-dcl-go-name: DisplayName\n          description: Optional. Display name for this environment.\n        lastModifiedAt:\n          type: integer\n          format: int64\n          x-dcl-go-name: LastModifiedAt\n          readOnly: true\n          description: Output only. Last modification time of this environment as\n            milliseconds since epoch.\n          x-kubernetes-immutable: true\n        name:\n          type: string\n          x-dcl-go-name: Name\n          description: Required. Name of the environment. Values must match the regular\n            expression ^[.\\p{Alnum}-_]{1,255}$\n          x-kubernetes-immutable: true\n        properties:\n          type: object\n          additionalProperties:\n            type: string\n          x-dcl-go-name: Properties\n          description: Optional. Key-value pairs that may be used for customizing\n            the environment.\n        state:\n          type: string\n          x-dcl-go-name: State\n          x-dcl-go-type: EnvironmentStateEnum\n          readOnly: true\n          description: 'Output only. State of the environment. Values other than ACTIVE\n            means the resource is not ready to use. Possible values: STATE_UNSPECIFIED,\n            CREATING, ACTIVE, DELETING'\n          x-kubernetes-immutable: true\n          enum:\n          - STATE_UNSPECIFIED\n          - CREATING\n          - ACTIVE\n          - DELETING\n")

blaze-out/k8-fastbuild/genfiles/cloud/graphite/mmv2/services/google/apigee/environment.yaml

View Source 
var YAML_instance = []byte("info:\n  title: Apigee/Instance\n  description: The Apigee Instance resource\n  x-dcl-struct-name: Instance\n  x-dcl-has-iam: false\npaths:\n  get:\n    description: The function used to get information about a Instance\n    parameters:\n    - name: Instance\n      required: true\n      description: A full instance of a Instance\n  apply:\n    description: The function used to apply information about a Instance\n    parameters:\n    - name: Instance\n      required: true\n      description: A full instance of a Instance\n  delete:\n    description: The function used to delete a Instance\n    parameters:\n    - name: Instance\n      required: true\n      description: A full instance of a Instance\n  deleteAll:\n    description: The function used to delete all Instance\n    parameters:\n    - name: apigeeorganization\n      required: true\n      schema:\n        type: string\n  list:\n    description: The function used to list information about many Instance\n    parameters:\n    - name: apigeeorganization\n      required: true\n      schema:\n        type: string\ncomponents:\n  schemas:\n    Instance:\n      title: Instance\n      x-dcl-id: organizations/{{apigee_organization}}/instances/{{name}}\n      x-dcl-has-iam: false\n      type: object\n      required:\n      - name\n      - location\n      - apigeeOrganization\n      properties:\n        apigeeOrganization:\n          type: string\n          x-dcl-go-name: ApigeeOrganization\n          description: The apigee organization for the resource\n          x-kubernetes-immutable: true\n          x-dcl-references:\n          - resource: Apigee/Organization\n            field: name\n            parent: true\n        createdAt:\n          type: integer\n          format: int64\n          x-dcl-go-name: CreatedAt\n          readOnly: true\n          description: Output only. Time the instance was created in milliseconds\n            since epoch.\n          x-kubernetes-immutable: true\n        description:\n          type: string\n          x-dcl-go-name: Description\n          description: Optional. Description of the instance.\n          x-kubernetes-immutable: true\n        diskEncryptionKeyName:\n          type: string\n          x-dcl-go-name: DiskEncryptionKeyName\n          description: 'Customer Managed Encryption Key (CMEK) used for disk and volume\n            encryption. Required for Apigee paid subscriptions only. Use the following\n            format: projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)'\n          x-kubernetes-immutable: true\n          x-dcl-references:\n          - resource: Cloudkms/CryptoKey\n            field: name\n        displayName:\n          type: string\n          x-dcl-go-name: DisplayName\n          description: Optional. Display name for the instance.\n          x-kubernetes-immutable: true\n        host:\n          type: string\n          x-dcl-go-name: Host\n          readOnly: true\n          description: Output only. Internal hostname or IP address of the Apigee\n            endpoint used by clients to connect to the service.\n          x-kubernetes-immutable: true\n        lastModifiedAt:\n          type: integer\n          format: int64\n          x-dcl-go-name: LastModifiedAt\n          readOnly: true\n          description: Output only. Time the instance was last modified in milliseconds\n            since epoch.\n          x-kubernetes-immutable: true\n        location:\n          type: string\n          x-dcl-go-name: Location\n          description: Required. Compute Engine location where the instance resides.\n          x-kubernetes-immutable: true\n        name:\n          type: string\n          x-dcl-go-name: Name\n          description: Required. Resource ID of the instance. Values must match the\n            regular expression ^[a-z][a-z\\-\\d]{0,30}[a-z\\d]$.\n          x-kubernetes-immutable: true\n        peeringCidrRange:\n          type: string\n          x-dcl-go-name: PeeringCidrRange\n          x-dcl-go-type: InstancePeeringCidrRangeEnum\n          description: 'Optional. Size of the CIDR block range that will be reserved\n            by the instance. PAID apigee_organizations support SLASH_16 to SLASH_20\n            and defaults to SLASH_16. Evaluation organizations support only SLASH_23.\n            Possible values: CIDR_RANGE_UNSPECIFIED, SLASH_16, SLASH_17, SLASH_18,\n            SLASH_19, SLASH_20, SLASH_23'\n          x-kubernetes-immutable: true\n          enum:\n          - CIDR_RANGE_UNSPECIFIED\n          - SLASH_16\n          - SLASH_17\n          - SLASH_18\n          - SLASH_19\n          - SLASH_20\n          - SLASH_23\n        port:\n          type: string\n          x-dcl-go-name: Port\n          readOnly: true\n          description: Output only. Port number of the exposed Apigee endpoint.\n          x-kubernetes-immutable: true\n        state:\n          type: string\n          x-dcl-go-name: State\n          x-dcl-go-type: InstanceStateEnum\n          readOnly: true\n          description: 'Output only. State of the instance. Values other than `ACTIVE`\n            means the resource is not ready to use. Possible values: SNAPSHOT_STATE_UNSPECIFIED,\n            MISSING, OK_DOCSTORE, OK_SUBMITTED, OK_EXTERNAL, DELETED'\n          x-kubernetes-immutable: true\n          enum:\n          - SNAPSHOT_STATE_UNSPECIFIED\n          - MISSING\n          - OK_DOCSTORE\n          - OK_SUBMITTED\n          - OK_EXTERNAL\n          - DELETED\n")

blaze-out/k8-fastbuild/genfiles/cloud/graphite/mmv2/services/google/apigee/instance.yaml

View Source 
var YAML_organization = []byte("info:\n  title: Apigee/Organization\n  description: The Apigee Organization resource\n  x-dcl-struct-name: Organization\n  x-dcl-has-iam: false\npaths:\n  get:\n    description: The function used to get information about a Organization\n    parameters:\n    - name: Organization\n      required: true\n      description: A full instance of a Organization\n  apply:\n    description: The function used to apply information about a Organization\n    parameters:\n    - name: Organization\n      required: true\n      description: A full instance of a Organization\n  delete:\n    description: The function used to delete a Organization\n    parameters:\n    - name: Organization\n      required: true\n      description: A full instance of a Organization\n  deleteAll:\n    description: The function used to delete all Organization\n    parameters: []\n  list:\n    description: The function used to list information about many Organization\n    parameters: []\ncomponents:\n  schemas:\n    Organization:\n      title: Organization\n      x-dcl-id: organizations/{{name}}\n      x-dcl-parent-container: project\n      x-dcl-has-iam: false\n      type: object\n      required:\n      - analyticsRegion\n      - runtimeType\n      properties:\n        addonsConfig:\n          type: object\n          x-dcl-go-name: AddonsConfig\n          x-dcl-go-type: OrganizationAddonsConfig\n          description: Addon configurations of the Apigee organization.\n          properties:\n            advancedApiOpsConfig:\n              type: object\n              x-dcl-go-name: AdvancedApiOpsConfig\n              x-dcl-go-type: OrganizationAddonsConfigAdvancedApiOpsConfig\n              description: Configuration for the Advanced API Ops add-on.\n              properties:\n                enabled:\n                  type: boolean\n                  x-dcl-go-name: Enabled\n                  description: Flag that specifies whether the Advanced API Ops add-on\n                    is enabled.\n            monetizationConfig:\n              type: object\n              x-dcl-go-name: MonetizationConfig\n              x-dcl-go-type: OrganizationAddonsConfigMonetizationConfig\n              description: Configuration for the Monetization add-on.\n              properties:\n                enabled:\n                  type: boolean\n                  x-dcl-go-name: Enabled\n                  description: Flag that specifies whether the Monetization add-on\n                    is enabled.\n        analyticsRegion:\n          type: string\n          x-dcl-go-name: AnalyticsRegion\n          description: Required. Primary GCP region for analytics data storage. For\n            valid values, see (https://cloud.google.com/apigee/docs/api-platform/get-started/create-org).\n          x-kubernetes-immutable: true\n        authorizedNetwork:\n          type: string\n          x-dcl-go-name: AuthorizedNetwork\n          description: 'Compute Engine network used for Service Networking to be peered\n            with Apigee runtime instances. See (https://cloud.google.com/vpc/docs/shared-vpc).\n            To use a shared VPC network, use the following format: `projects/{host-project-id}/{region}/networks/{network-name}`.\n            For example: `projects/my-sharedvpc-host/global/networks/mynetwork` **Note:**\n            Not supported for Apigee hybrid.'\n          x-dcl-references:\n          - resource: Compute/Network\n            field: name\n        billingType:\n          type: string\n          x-dcl-go-name: BillingType\n          x-dcl-go-type: OrganizationBillingTypeEnum\n          readOnly: true\n          description: 'Output only. Billing type of the Apigee organization. See\n            (https://cloud.google.com/apigee/pricing). Possible values: BILLING_TYPE_UNSPECIFIED,\n            SUBSCRIPTION, EVALUATION'\n          x-kubernetes-immutable: true\n          enum:\n          - BILLING_TYPE_UNSPECIFIED\n          - SUBSCRIPTION\n          - EVALUATION\n        caCertificate:\n          type: string\n          x-dcl-go-name: CaCertificate\n          readOnly: true\n          description: Output only. Base64-encoded public certificate for the root\n            CA of the Apigee organization. Valid only when (#RuntimeType) is `CLOUD`.\n          x-kubernetes-immutable: true\n        createdAt:\n          type: integer\n          format: int64\n          x-dcl-go-name: CreatedAt\n          readOnly: true\n          description: Output only. Time that the Apigee organization was created\n            in milliseconds since epoch.\n          x-kubernetes-immutable: true\n        description:\n          type: string\n          x-dcl-go-name: Description\n          description: Description of the Apigee organization.\n        displayName:\n          type: string\n          x-dcl-go-name: DisplayName\n          description: Display name for the Apigee organization.\n        environments:\n          type: array\n          x-dcl-go-name: Environments\n          readOnly: true\n          description: Output only. List of environments in the Apigee organization.\n          x-kubernetes-immutable: true\n          x-dcl-list-type: list\n          items:\n            type: string\n            x-dcl-go-type: string\n        expiresAt:\n          type: integer\n          format: int64\n          x-dcl-go-name: ExpiresAt\n          readOnly: true\n          description: Output only. Time that the Apigee organization is scheduled\n            for deletion.\n          x-kubernetes-immutable: true\n        lastModifiedAt:\n          type: integer\n          format: int64\n          x-dcl-go-name: LastModifiedAt\n          readOnly: true\n          description: Output only. Time that the Apigee organization was last modified\n            in milliseconds since epoch.\n          x-kubernetes-immutable: true\n        name:\n          type: string\n          x-dcl-go-name: Name\n          description: Output only. Name of the Apigee organization.\n          x-kubernetes-immutable: true\n          x-dcl-server-generated-parameter: true\n        project:\n          type: string\n          x-dcl-go-name: Project\n          description: 'Required. Name of the GCP project in which to associate the\n            Apigee organization. Pass the information as a query parameter using the\n            following structure in your request: projects/<project> Authorization\n            requires the following IAM permission on the specified resource parent:\n            apigee.organizations.create'\n          x-kubernetes-immutable: true\n          x-dcl-forward-slash-allowed: true\n          x-dcl-references:\n          - resource: Cloudresourcemanager/Project\n            field: name\n            parent: true\n        projectId:\n          type: string\n          x-dcl-go-name: ProjectId\n          readOnly: true\n          description: Output only. Project ID associated with the Apigee organization.\n          x-kubernetes-immutable: true\n        properties:\n          type: object\n          additionalProperties:\n            type: string\n          x-dcl-go-name: Properties\n          description: Properties defined in the Apigee organization profile.\n        runtimeDatabaseEncryptionKeyName:\n          type: string\n          x-dcl-go-name: RuntimeDatabaseEncryptionKeyName\n          description: 'Cloud KMS key name used for encrypting the data that is stored\n            and replicated across runtime instances. Update is not allowed after the\n            organization is created. Required when (#RuntimeType) is `TRIAL`, a Google-Managed\n            encryption key will be used. For example: \"projects/foo/locations/us/keyRings/bar/cryptoKeys/baz\".\n            **Note:** Not supported for Apigee hybrid.'\n          x-dcl-references:\n          - resource: Cloudkms/CryptoKey\n            field: name\n        runtimeType:\n          type: string\n          x-dcl-go-name: RuntimeType\n          x-dcl-go-type: OrganizationRuntimeTypeEnum\n          description: 'Required. Runtime type of the Apigee organization based on\n            the Apigee subscription purchased. Possible values: RUNTIME_TYPE_UNSPECIFIED,\n            CLOUD, HYBRID'\n          x-kubernetes-immutable: true\n          enum:\n          - RUNTIME_TYPE_UNSPECIFIED\n          - CLOUD\n          - HYBRID\n        state:\n          type: string\n          x-dcl-go-name: State\n          x-dcl-go-type: OrganizationStateEnum\n          readOnly: true\n          description: 'Output only. State of the organization. Values other than\n            ACTIVE means the resource is not ready to use. Possible values: SNAPSHOT_STATE_UNSPECIFIED,\n            MISSING, OK_DOCSTORE, OK_SUBMITTED, OK_EXTERNAL, DELETED'\n          x-kubernetes-immutable: true\n          enum:\n          - SNAPSHOT_STATE_UNSPECIFIED\n          - MISSING\n          - OK_DOCSTORE\n          - OK_SUBMITTED\n          - OK_EXTERNAL\n          - DELETED\n        subscriptionType:\n          type: string\n          x-dcl-go-name: SubscriptionType\n          x-dcl-go-type: OrganizationSubscriptionTypeEnum\n          readOnly: true\n          description: 'Output only. DEPRECATED: This will eventually be replaced\n            by BillingType. Subscription type of the Apigee organization. Valid values\n            include trial (free, limited, and for evaluation purposes only) or paid\n            (full subscription has been purchased). See (https://cloud.google.com/apigee/pricing/).\n            Possible values: SUBSCRIPTION_TYPE_UNSPECIFIED, PAID, TRIAL'\n          x-kubernetes-immutable: true\n          enum:\n          - SUBSCRIPTION_TYPE_UNSPECIFIED\n          - PAID\n          - TRIAL\n")

blaze-out/k8-fastbuild/genfiles/cloud/graphite/mmv2/services/google/apigee/organization.yaml

Functions

This section is empty.

Types

type Attachment 

type Attachment struct {
	Name        *string `json:"name"`
	Environment *string `json:"environment"`
	CreatedAt   *int64  `json:"createdAt"`
	Envgroup    *string `json:"envgroup"`
}

func (*Attachment) Describe 

func (r *Attachment) Describe() dcl.ServiceTypeVersion

Describe returns a simple description of this resource to ensure that automated tools can identify it.

func (*Attachment) ID 

func (r *Attachment) ID() (string, error)

func (*Attachment) String 

func (r *Attachment) String() string

type AttachmentList 

type AttachmentList struct {
	Items []*Attachment
	// contains filtered or unexported fields
}

func (*AttachmentList) HasNext 

func (l *AttachmentList) HasNext() bool

func (*AttachmentList) Next 

func (l *AttachmentList) Next(ctx context.Context, c *Client) error

type Client 

type Client struct {
	Config *dcl.Config
}

The Client is the base struct of all operations. This will receive the Get, Delete, List, and Apply operations on all resources.

func NewClient 

func NewClient(c *dcl.Config) *Client

NewClient creates a client that retries all operations a few times each.

func (*Client) ApplyAttachment 

func (c *Client) ApplyAttachment(ctx context.Context, rawDesired *Attachment, opts ...dcl.ApplyOption) (*Attachment, error)

func (*Client) ApplyEnvgroup 

func (c *Client) ApplyEnvgroup(ctx context.Context, rawDesired *Envgroup, opts ...dcl.ApplyOption) (*Envgroup, error)

func (*Client) ApplyEnvironment 

func (c *Client) ApplyEnvironment(ctx context.Context, rawDesired *Environment, opts ...dcl.ApplyOption) (*Environment, error)

func (*Client) ApplyInstance 

func (c *Client) ApplyInstance(ctx context.Context, rawDesired *Instance, opts ...dcl.ApplyOption) (*Instance, error)

func (*Client) ApplyOrganization 

func (c *Client) ApplyOrganization(ctx context.Context, rawDesired *Organization, opts ...dcl.ApplyOption) (*Organization, error)

func (*Client) DeleteAllAttachment 

func (c *Client) DeleteAllAttachment(ctx context.Context, envgroup string, filter func(*Attachment) bool) error

DeleteAllAttachment deletes all resources that the filter functions returns true on.

func (*Client) DeleteAllEnvgroup 

func (c *Client) DeleteAllEnvgroup(ctx context.Context, apigeeOrganization string, filter func(*Envgroup) bool) error

DeleteAllEnvgroup deletes all resources that the filter functions returns true on.

func (*Client) DeleteAllEnvironment 

func (c *Client) DeleteAllEnvironment(ctx context.Context, apigeeOrganization string, filter func(*Environment) bool) error

DeleteAllEnvironment deletes all resources that the filter functions returns true on.

func (*Client) DeleteAllInstance 

func (c *Client) DeleteAllInstance(ctx context.Context, apigeeOrganization string, filter func(*Instance) bool) error

DeleteAllInstance deletes all resources that the filter functions returns true on.

func (*Client) DeleteAllOrganization 

func (c *Client) DeleteAllOrganization(ctx context.Context, filter func(*Organization) bool) error

DeleteAllOrganization deletes all resources that the filter functions returns true on.

func (*Client) DeleteAttachment 

func (c *Client) DeleteAttachment(ctx context.Context, r *Attachment) error

func (*Client) DeleteEnvgroup 

func (c *Client) DeleteEnvgroup(ctx context.Context, r *Envgroup) error

func (*Client) DeleteEnvironment 

func (c *Client) DeleteEnvironment(ctx context.Context, r *Environment) error

func (*Client) DeleteInstance 

func (c *Client) DeleteInstance(ctx context.Context, r *Instance) error

func (*Client) DeleteOrganization 

func (c *Client) DeleteOrganization(ctx context.Context, r *Organization) error

func (*Client) GetAttachment 

func (c *Client) GetAttachment(ctx context.Context, r *Attachment) (*Attachment, error)

func (*Client) GetEnvgroup 

func (c *Client) GetEnvgroup(ctx context.Context, r *Envgroup) (*Envgroup, error)

func (*Client) GetEnvironment 

func (c *Client) GetEnvironment(ctx context.Context, r *Environment) (*Environment, error)

func (*Client) GetInstance 

func (c *Client) GetInstance(ctx context.Context, r *Instance) (*Instance, error)

func (*Client) GetOrganization 

func (c *Client) GetOrganization(ctx context.Context, r *Organization) (*Organization, error)

func (*Client) ListAttachment 

func (c *Client) ListAttachment(ctx context.Context, envgroup string) (*AttachmentList, error)

func (*Client) ListAttachmentWithMaxResults 

func (c *Client) ListAttachmentWithMaxResults(ctx context.Context, envgroup string, pageSize int32) (*AttachmentList, error)

func (*Client) ListEnvgroup 

func (c *Client) ListEnvgroup(ctx context.Context, apigeeOrganization string) (*EnvgroupList, error)

func (*Client) ListEnvgroupWithMaxResults 

func (c *Client) ListEnvgroupWithMaxResults(ctx context.Context, apigeeOrganization string, pageSize int32) (*EnvgroupList, error)

func (*Client) ListEnvironment 

func (c *Client) ListEnvironment(ctx context.Context, apigeeOrganization string) (*EnvironmentList, error)

ListEnvironment returns an EnvironmentList containing all Environment resources in the given organization.

func (*Client) ListEnvironmentWithMaxResults 

func (c *Client) ListEnvironmentWithMaxResults(ctx context.Context, apigeeOrganization string, pageSize int32) (*EnvironmentList, error)

ListEnvironmentWithMaxResults returns an EnvironmentList containing all Environment resources in the given organization.

func (*Client) ListInstance 

func (c *Client) ListInstance(ctx context.Context, apigeeOrganization string) (*InstanceList, error)

func (*Client) ListInstanceWithMaxResults 

func (c *Client) ListInstanceWithMaxResults(ctx context.Context, apigeeOrganization string, pageSize int32) (*InstanceList, error)

func (*Client) ListOrganization 

func (c *Client) ListOrganization(ctx context.Context) (*OrganizationList, error)

ListOrganization returns a list of apigee organizations which the client has permission to access.

func (*Client) ListOrganizationWithMaxResults 

func (c *Client) ListOrganizationWithMaxResults(ctx context.Context, pageSize int32) (*OrganizationList, error)

ListOrganizationWithMaxResults returns a list of apigee organizations with the given page size.

type Envgroup 

type Envgroup struct {
	Name               *string            `json:"name"`
	Hostnames          []string           `json:"hostnames"`
	CreatedAt          *int64             `json:"createdAt"`
	LastModifiedAt     *int64             `json:"lastModifiedAt"`
	State              *EnvgroupStateEnum `json:"state"`
	ApigeeOrganization *string            `json:"apigeeOrganization"`
}

func (*Envgroup) Describe 

func (r *Envgroup) Describe() dcl.ServiceTypeVersion

Describe returns a simple description of this resource to ensure that automated tools can identify it.

func (*Envgroup) ID 

func (r *Envgroup) ID() (string, error)

func (*Envgroup) String 

func (r *Envgroup) String() string

type EnvgroupList 

type EnvgroupList struct {
	Items []*Envgroup
	// contains filtered or unexported fields
}

func (*EnvgroupList) HasNext 

func (l *EnvgroupList) HasNext() bool

func (*EnvgroupList) Next 

func (l *EnvgroupList) Next(ctx context.Context, c *Client) error

type EnvgroupStateEnum 

type EnvgroupStateEnum string

The enum EnvgroupStateEnum.

func EnvgroupStateEnumRef 

func EnvgroupStateEnumRef(s string) *EnvgroupStateEnum

EnvgroupStateEnumRef returns a *EnvgroupStateEnum with the value of string s If the empty string is provided, nil is returned.

func (EnvgroupStateEnum) Validate 

func (v EnvgroupStateEnum) Validate() error

type Environment 

type Environment struct {
	Name               *string               `json:"name"`
	Description        *string               `json:"description"`
	CreatedAt          *int64                `json:"createdAt"`
	LastModifiedAt     *int64                `json:"lastModifiedAt"`
	Properties         map[string]string     `json:"properties"`
	DisplayName        *string               `json:"displayName"`
	State              *EnvironmentStateEnum `json:"state"`
	ApigeeOrganization *string               `json:"apigeeOrganization"`
}

func (*Environment) Describe 

func (r *Environment) Describe() dcl.ServiceTypeVersion

Describe returns a simple description of this resource to ensure that automated tools can identify it.

func (*Environment) GetPolicy 

func (r *Environment) GetPolicy(basePath string) (string, string, *bytes.Buffer, error)

func (*Environment) IAMPolicyVersion 

func (r *Environment) IAMPolicyVersion() int

func (*Environment) ID 

func (r *Environment) ID() (string, error)

func (*Environment) SetPolicyURL 

func (r *Environment) SetPolicyURL(userBasePath string) string

func (*Environment) SetPolicyVerb 

func (r *Environment) SetPolicyVerb() string

func (*Environment) String 

func (r *Environment) String() string

type EnvironmentList 

type EnvironmentList struct {
	Items []*Environment
	// contains filtered or unexported fields
}

func (*EnvironmentList) HasNext 

func (l *EnvironmentList) HasNext() bool

HasNext returns an empty token.

func (*EnvironmentList) Next 

func (l *EnvironmentList) Next(ctx context.Context, c *Client) error

Next returns an error because environment list has no pages.

type EnvironmentStateEnum 

type EnvironmentStateEnum string

The enum EnvironmentStateEnum.

func EnvironmentStateEnumRef 

func EnvironmentStateEnumRef(s string) *EnvironmentStateEnum

EnvironmentStateEnumRef returns a *EnvironmentStateEnum with the value of string s If the empty string is provided, nil is returned.

func (EnvironmentStateEnum) Validate 

func (v EnvironmentStateEnum) Validate() error

type Instance 

type Instance struct {
	Name                  *string                       `json:"name"`
	Location              *string                       `json:"location"`
	PeeringCidrRange      *InstancePeeringCidrRangeEnum `json:"peeringCidrRange"`
	Host                  *string                       `json:"host"`
	Port                  *string                       `json:"port"`
	Description           *string                       `json:"description"`
	DisplayName           *string                       `json:"displayName"`
	CreatedAt             *int64                        `json:"createdAt"`
	LastModifiedAt        *int64                        `json:"lastModifiedAt"`
	DiskEncryptionKeyName *string                       `json:"diskEncryptionKeyName"`
	State                 *InstanceStateEnum            `json:"state"`
	ApigeeOrganization    *string                       `json:"apigeeOrganization"`
}

func (*Instance) Describe 

func (r *Instance) Describe() dcl.ServiceTypeVersion

Describe returns a simple description of this resource to ensure that automated tools can identify it.

func (*Instance) ID 

func (r *Instance) ID() (string, error)

func (*Instance) String 

func (r *Instance) String() string

type InstanceList 

type InstanceList struct {
	Items []*Instance
	// contains filtered or unexported fields
}

func (*InstanceList) HasNext 

func (l *InstanceList) HasNext() bool

func (*InstanceList) Next 

func (l *InstanceList) Next(ctx context.Context, c *Client) error

type InstancePeeringCidrRangeEnum 

type InstancePeeringCidrRangeEnum string

The enum InstancePeeringCidrRangeEnum.

func InstancePeeringCidrRangeEnumRef 

func InstancePeeringCidrRangeEnumRef(s string) *InstancePeeringCidrRangeEnum

InstancePeeringCidrRangeEnumRef returns a *InstancePeeringCidrRangeEnum with the value of string s If the empty string is provided, nil is returned.

func (InstancePeeringCidrRangeEnum) Validate 

func (v InstancePeeringCidrRangeEnum) Validate() error

type InstanceStateEnum 

type InstanceStateEnum string

The enum InstanceStateEnum.

func InstanceStateEnumRef 

func InstanceStateEnumRef(s string) *InstanceStateEnum

InstanceStateEnumRef returns a *InstanceStateEnum with the value of string s If the empty string is provided, nil is returned.

func (InstanceStateEnum) Validate 

func (v InstanceStateEnum) Validate() error

type Organization 

type Organization struct {
	Name                             *string                           `json:"name"`
	DisplayName                      *string                           `json:"displayName"`
	Description                      *string                           `json:"description"`
	CreatedAt                        *int64                            `json:"createdAt"`
	LastModifiedAt                   *int64                            `json:"lastModifiedAt"`
	ExpiresAt                        *int64                            `json:"expiresAt"`
	Environments                     []string                          `json:"environments"`
	Properties                       map[string]string                 `json:"properties"`
	AnalyticsRegion                  *string                           `json:"analyticsRegion"`
	AuthorizedNetwork                *string                           `json:"authorizedNetwork"`
	RuntimeType                      *OrganizationRuntimeTypeEnum      `json:"runtimeType"`
	SubscriptionType                 *OrganizationSubscriptionTypeEnum `json:"subscriptionType"`
	BillingType                      *OrganizationBillingTypeEnum      `json:"billingType"`
	AddonsConfig                     *OrganizationAddonsConfig         `json:"addonsConfig"`
	CaCertificate                    *string                           `json:"caCertificate"`
	RuntimeDatabaseEncryptionKeyName *string                           `json:"runtimeDatabaseEncryptionKeyName"`
	ProjectId                        *string                           `json:"projectId"`
	State                            *OrganizationStateEnum            `json:"state"`
	Project                          *string                           `json:"project"`
}

func (*Organization) Describe 

func (r *Organization) Describe() dcl.ServiceTypeVersion

Describe returns a simple description of this resource to ensure that automated tools can identify it.

func (*Organization) ID 

func (r *Organization) ID() (string, error)

func (*Organization) String 

func (r *Organization) String() string

type OrganizationAddonsConfig 

type OrganizationAddonsConfig struct {
	AdvancedApiOpsConfig *OrganizationAddonsConfigAdvancedApiOpsConfig `json:"advancedApiOpsConfig"`
	MonetizationConfig   *OrganizationAddonsConfigMonetizationConfig   `json:"monetizationConfig"`
	// contains filtered or unexported fields
}
var EmptyOrganizationAddonsConfig *OrganizationAddonsConfig = &OrganizationAddonsConfig{empty: true}

This object is used to assert a desired state where this OrganizationAddonsConfig is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.

func (*OrganizationAddonsConfig) Empty 

func (r *OrganizationAddonsConfig) Empty() bool

func (*OrganizationAddonsConfig) HashCode 

func (r *OrganizationAddonsConfig) HashCode() string

func (*OrganizationAddonsConfig) String 

func (r *OrganizationAddonsConfig) String() string

func (*OrganizationAddonsConfig) UnmarshalJSON 

func (r *OrganizationAddonsConfig) UnmarshalJSON(data []byte) error

type OrganizationAddonsConfigAdvancedApiOpsConfig 

type OrganizationAddonsConfigAdvancedApiOpsConfig struct {
	Enabled *bool `json:"enabled"`
	// contains filtered or unexported fields
}
var EmptyOrganizationAddonsConfigAdvancedApiOpsConfig *OrganizationAddonsConfigAdvancedApiOpsConfig = &OrganizationAddonsConfigAdvancedApiOpsConfig{empty: true}

This object is used to assert a desired state where this OrganizationAddonsConfigAdvancedApiOpsConfig is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.

func (*OrganizationAddonsConfigAdvancedApiOpsConfig) Empty 

func (r *OrganizationAddonsConfigAdvancedApiOpsConfig) Empty() bool

func (*OrganizationAddonsConfigAdvancedApiOpsConfig) HashCode 

func (r *OrganizationAddonsConfigAdvancedApiOpsConfig) HashCode() string

func (*OrganizationAddonsConfigAdvancedApiOpsConfig) String 

func (r *OrganizationAddonsConfigAdvancedApiOpsConfig) String() string

func (*OrganizationAddonsConfigAdvancedApiOpsConfig) UnmarshalJSON 

func (r *OrganizationAddonsConfigAdvancedApiOpsConfig) UnmarshalJSON(data []byte) error

type OrganizationAddonsConfigMonetizationConfig 

type OrganizationAddonsConfigMonetizationConfig struct {
	Enabled *bool `json:"enabled"`
	// contains filtered or unexported fields
}
var EmptyOrganizationAddonsConfigMonetizationConfig *OrganizationAddonsConfigMonetizationConfig = &OrganizationAddonsConfigMonetizationConfig{empty: true}

This object is used to assert a desired state where this OrganizationAddonsConfigMonetizationConfig is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.

func (*OrganizationAddonsConfigMonetizationConfig) Empty 

func (r *OrganizationAddonsConfigMonetizationConfig) Empty() bool

func (*OrganizationAddonsConfigMonetizationConfig) HashCode 

func (r *OrganizationAddonsConfigMonetizationConfig) HashCode() string

func (*OrganizationAddonsConfigMonetizationConfig) String 

func (r *OrganizationAddonsConfigMonetizationConfig) String() string

func (*OrganizationAddonsConfigMonetizationConfig) UnmarshalJSON 

func (r *OrganizationAddonsConfigMonetizationConfig) UnmarshalJSON(data []byte) error

type OrganizationBillingTypeEnum 

type OrganizationBillingTypeEnum string

The enum OrganizationBillingTypeEnum.

func OrganizationBillingTypeEnumRef 

func OrganizationBillingTypeEnumRef(s string) *OrganizationBillingTypeEnum

OrganizationBillingTypeEnumRef returns a *OrganizationBillingTypeEnum with the value of string s If the empty string is provided, nil is returned.

func (OrganizationBillingTypeEnum) Validate 

func (v OrganizationBillingTypeEnum) Validate() error

type OrganizationList 

type OrganizationList struct {
	Items []*Organization
	// contains filtered or unexported fields
}

func (*OrganizationList) HasNext 

func (l *OrganizationList) HasNext() bool

HasNext returns whether the list has a next page.

func (*OrganizationList) Next 

func (l *OrganizationList) Next(ctx context.Context, c *Client) error

Next advances the list to its next page.

type OrganizationRuntimeTypeEnum 

type OrganizationRuntimeTypeEnum string

The enum OrganizationRuntimeTypeEnum.

func OrganizationRuntimeTypeEnumRef 

func OrganizationRuntimeTypeEnumRef(s string) *OrganizationRuntimeTypeEnum

OrganizationRuntimeTypeEnumRef returns a *OrganizationRuntimeTypeEnum with the value of string s If the empty string is provided, nil is returned.

func (OrganizationRuntimeTypeEnum) Validate 

func (v OrganizationRuntimeTypeEnum) Validate() error

type OrganizationStateEnum 

type OrganizationStateEnum string

The enum OrganizationStateEnum.

func OrganizationStateEnumRef 

func OrganizationStateEnumRef(s string) *OrganizationStateEnum

OrganizationStateEnumRef returns a *OrganizationStateEnum with the value of string s If the empty string is provided, nil is returned.

func (OrganizationStateEnum) Validate 

func (v OrganizationStateEnum) Validate() error

type OrganizationSubscriptionTypeEnum 

type OrganizationSubscriptionTypeEnum string

The enum OrganizationSubscriptionTypeEnum.

func OrganizationSubscriptionTypeEnumRef 

func OrganizationSubscriptionTypeEnumRef(s string) *OrganizationSubscriptionTypeEnum

OrganizationSubscriptionTypeEnumRef returns a *OrganizationSubscriptionTypeEnum with the value of string s If the empty string is provided, nil is returned.

func (OrganizationSubscriptionTypeEnum) Validate 

func (v OrganizationSubscriptionTypeEnum) Validate() error

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.