gcp.apihub.Curation
Explore with Pulumi AI
Description
Example Usage
Apihub Curation Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const apihubCurationBasic = new gcp.apihub.Curation("apihub_curation_basic", {
location: "us-central1",
curationId: "test",
project: "apihub-terraform",
displayName: "Test Curation",
description: "This is a sample curation resource managed by Terraform.",
endpoint: {
applicationIntegrationEndpointDetails: {
triggerId: "api_trigger/curation_API_1",
uri: "https://integrations.googleapis.com/v1/projects/1082615593856/locations/us-central1/integrations/curation:execute",
},
},
});
import pulumi
import pulumi_gcp as gcp
apihub_curation_basic = gcp.apihub.Curation("apihub_curation_basic",
location="us-central1",
curation_id="test",
project="apihub-terraform",
display_name="Test Curation",
description="This is a sample curation resource managed by Terraform.",
endpoint={
"application_integration_endpoint_details": {
"trigger_id": "api_trigger/curation_API_1",
"uri": "https://integrations.googleapis.com/v1/projects/1082615593856/locations/us-central1/integrations/curation:execute",
},
})
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/apihub"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apihub.NewCuration(ctx, "apihub_curation_basic", &apihub.CurationArgs{
Location: pulumi.String("us-central1"),
CurationId: pulumi.String("test"),
Project: pulumi.String("apihub-terraform"),
DisplayName: pulumi.String("Test Curation"),
Description: pulumi.String("This is a sample curation resource managed by Terraform."),
Endpoint: &apihub.CurationEndpointArgs{
ApplicationIntegrationEndpointDetails: &apihub.CurationEndpointApplicationIntegrationEndpointDetailsArgs{
TriggerId: pulumi.String("api_trigger/curation_API_1"),
Uri: pulumi.String("https://integrations.googleapis.com/v1/projects/1082615593856/locations/us-central1/integrations/curation:execute"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var apihubCurationBasic = new Gcp.ApiHub.Curation("apihub_curation_basic", new()
{
Location = "us-central1",
CurationId = "test",
Project = "apihub-terraform",
DisplayName = "Test Curation",
Description = "This is a sample curation resource managed by Terraform.",
Endpoint = new Gcp.ApiHub.Inputs.CurationEndpointArgs
{
ApplicationIntegrationEndpointDetails = new Gcp.ApiHub.Inputs.CurationEndpointApplicationIntegrationEndpointDetailsArgs
{
TriggerId = "api_trigger/curation_API_1",
Uri = "https://integrations.googleapis.com/v1/projects/1082615593856/locations/us-central1/integrations/curation:execute",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.apihub.Curation;
import com.pulumi.gcp.apihub.CurationArgs;
import com.pulumi.gcp.apihub.inputs.CurationEndpointArgs;
import com.pulumi.gcp.apihub.inputs.CurationEndpointApplicationIntegrationEndpointDetailsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var apihubCurationBasic = new Curation("apihubCurationBasic", CurationArgs.builder()
.location("us-central1")
.curationId("test")
.project("apihub-terraform")
.displayName("Test Curation")
.description("This is a sample curation resource managed by Terraform.")
.endpoint(CurationEndpointArgs.builder()
.applicationIntegrationEndpointDetails(CurationEndpointApplicationIntegrationEndpointDetailsArgs.builder()
.triggerId("api_trigger/curation_API_1")
.uri("https://integrations.googleapis.com/v1/projects/1082615593856/locations/us-central1/integrations/curation:execute")
.build())
.build())
.build());
}
}
resources:
apihubCurationBasic:
type: gcp:apihub:Curation
name: apihub_curation_basic
properties:
location: us-central1
curationId: test
project: apihub-terraform
displayName: Test Curation
description: This is a sample curation resource managed by Terraform.
endpoint:
applicationIntegrationEndpointDetails:
triggerId: api_trigger/curation_API_1
uri: https://integrations.googleapis.com/v1/projects/1082615593856/locations/us-central1/integrations/curation:execute
Create Curation Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Curation(name: string, args: CurationArgs, opts?: CustomResourceOptions);
@overload
def Curation(resource_name: str,
args: CurationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Curation(resource_name: str,
opts: Optional[ResourceOptions] = None,
curation_id: Optional[str] = None,
display_name: Optional[str] = None,
endpoint: Optional[CurationEndpointArgs] = None,
location: Optional[str] = None,
description: Optional[str] = None,
project: Optional[str] = None)
func NewCuration(ctx *Context, name string, args CurationArgs, opts ...ResourceOption) (*Curation, error)
public Curation(string name, CurationArgs args, CustomResourceOptions? opts = null)
public Curation(String name, CurationArgs args)
public Curation(String name, CurationArgs args, CustomResourceOptions options)
type: gcp:apihub:Curation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args CurationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args CurationArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CurationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CurationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CurationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var curationResource = new Gcp.ApiHub.Curation("curationResource", new()
{
CurationId = "string",
DisplayName = "string",
Endpoint = new Gcp.ApiHub.Inputs.CurationEndpointArgs
{
ApplicationIntegrationEndpointDetails = new Gcp.ApiHub.Inputs.CurationEndpointApplicationIntegrationEndpointDetailsArgs
{
TriggerId = "string",
Uri = "string",
},
},
Location = "string",
Description = "string",
Project = "string",
});
example, err := apihub.NewCuration(ctx, "curationResource", &apihub.CurationArgs{
CurationId: pulumi.String("string"),
DisplayName: pulumi.String("string"),
Endpoint: &apihub.CurationEndpointArgs{
ApplicationIntegrationEndpointDetails: &apihub.CurationEndpointApplicationIntegrationEndpointDetailsArgs{
TriggerId: pulumi.String("string"),
Uri: pulumi.String("string"),
},
},
Location: pulumi.String("string"),
Description: pulumi.String("string"),
Project: pulumi.String("string"),
})
var curationResource = new Curation("curationResource", CurationArgs.builder()
.curationId("string")
.displayName("string")
.endpoint(CurationEndpointArgs.builder()
.applicationIntegrationEndpointDetails(CurationEndpointApplicationIntegrationEndpointDetailsArgs.builder()
.triggerId("string")
.uri("string")
.build())
.build())
.location("string")
.description("string")
.project("string")
.build());
curation_resource = gcp.apihub.Curation("curationResource",
curation_id="string",
display_name="string",
endpoint={
"application_integration_endpoint_details": {
"trigger_id": "string",
"uri": "string",
},
},
location="string",
description="string",
project="string")
const curationResource = new gcp.apihub.Curation("curationResource", {
curationId: "string",
displayName: "string",
endpoint: {
applicationIntegrationEndpointDetails: {
triggerId: "string",
uri: "string",
},
},
location: "string",
description: "string",
project: "string",
});
type: gcp:apihub:Curation
properties:
curationId: string
description: string
displayName: string
endpoint:
applicationIntegrationEndpointDetails:
triggerId: string
uri: string
location: string
project: string
Curation Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Curation resource accepts the following input properties:
- Curation
Id string - The ID to use for the curation resource, which will become the final
component of the curations's resource name. This field is optional.
- If provided, the same will be used. The service will throw an error if the specified ID is already used by another curation resource in the API hub.
- If not provided, a system generated ID will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
- Display
Name string - The display name of the curation.
- Endpoint
Curation
Endpoint - The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. Structure is documented below.
- Location string
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Description string
- The description of the curation.
- Project string
- Curation
Id string - The ID to use for the curation resource, which will become the final
component of the curations's resource name. This field is optional.
- If provided, the same will be used. The service will throw an error if the specified ID is already used by another curation resource in the API hub.
- If not provided, a system generated ID will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
- Display
Name string - The display name of the curation.
- Endpoint
Curation
Endpoint Args - The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. Structure is documented below.
- Location string
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Description string
- The description of the curation.
- Project string
- curation
Id String - The ID to use for the curation resource, which will become the final
component of the curations's resource name. This field is optional.
- If provided, the same will be used. The service will throw an error if the specified ID is already used by another curation resource in the API hub.
- If not provided, a system generated ID will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
- display
Name String - The display name of the curation.
- endpoint
Curation
Endpoint - The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. Structure is documented below.
- location String
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - description String
- The description of the curation.
- project String
- curation
Id string - The ID to use for the curation resource, which will become the final
component of the curations's resource name. This field is optional.
- If provided, the same will be used. The service will throw an error if the specified ID is already used by another curation resource in the API hub.
- If not provided, a system generated ID will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
- display
Name string - The display name of the curation.
- endpoint
Curation
Endpoint - The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. Structure is documented below.
- location string
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - description string
- The description of the curation.
- project string
- curation_
id str - The ID to use for the curation resource, which will become the final
component of the curations's resource name. This field is optional.
- If provided, the same will be used. The service will throw an error if the specified ID is already used by another curation resource in the API hub.
- If not provided, a system generated ID will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
- display_
name str - The display name of the curation.
- endpoint
Curation
Endpoint Args - The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. Structure is documented below.
- location str
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - description str
- The description of the curation.
- project str
- curation
Id String - The ID to use for the curation resource, which will become the final
component of the curations's resource name. This field is optional.
- If provided, the same will be used. The service will throw an error if the specified ID is already used by another curation resource in the API hub.
- If not provided, a system generated ID will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
- display
Name String - The display name of the curation.
- endpoint Property Map
- The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. Structure is documented below.
- location String
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - description String
- The description of the curation.
- project String
Outputs
All input properties are implicitly available as output properties. Additionally, the Curation resource produces the following output properties:
- Create
Time string - The time at which the curation was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Execution stringError Code - The error code of the last execution of the curation. The error code is populated only when the last execution state is failed. Possible values: ERROR_CODE_UNSPECIFIED INTERNAL_ERROR UNAUTHORIZED
- Last
Execution stringError Message - Error message describing the failure, if any, during the last execution of the curation.
- Last
Execution stringState - The last execution state of the curation. Possible values: LAST_EXECUTION_STATE_UNSPECIFIED SUCCEEDED FAILED
- Name string
- Identifier. The name of the curation.
Format:
projects/{project}/locations/{location}/curations/{curation}
- Plugin
Instance List<CurationActions Plugin Instance Action> - The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance. Structure is documented below.
- Update
Time string - The time at which the curation was last updated.
- Create
Time string - The time at which the curation was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Execution stringError Code - The error code of the last execution of the curation. The error code is populated only when the last execution state is failed. Possible values: ERROR_CODE_UNSPECIFIED INTERNAL_ERROR UNAUTHORIZED
- Last
Execution stringError Message - Error message describing the failure, if any, during the last execution of the curation.
- Last
Execution stringState - The last execution state of the curation. Possible values: LAST_EXECUTION_STATE_UNSPECIFIED SUCCEEDED FAILED
- Name string
- Identifier. The name of the curation.
Format:
projects/{project}/locations/{location}/curations/{curation}
- Plugin
Instance []CurationActions Plugin Instance Action - The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance. Structure is documented below.
- Update
Time string - The time at which the curation was last updated.
- create
Time String - The time at which the curation was created.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Execution StringError Code - The error code of the last execution of the curation. The error code is populated only when the last execution state is failed. Possible values: ERROR_CODE_UNSPECIFIED INTERNAL_ERROR UNAUTHORIZED
- last
Execution StringError Message - Error message describing the failure, if any, during the last execution of the curation.
- last
Execution StringState - The last execution state of the curation. Possible values: LAST_EXECUTION_STATE_UNSPECIFIED SUCCEEDED FAILED
- name String
- Identifier. The name of the curation.
Format:
projects/{project}/locations/{location}/curations/{curation}
- plugin
Instance List<CurationActions Plugin Instance Action> - The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance. Structure is documented below.
- update
Time String - The time at which the curation was last updated.
- create
Time string - The time at which the curation was created.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Execution stringError Code - The error code of the last execution of the curation. The error code is populated only when the last execution state is failed. Possible values: ERROR_CODE_UNSPECIFIED INTERNAL_ERROR UNAUTHORIZED
- last
Execution stringError Message - Error message describing the failure, if any, during the last execution of the curation.
- last
Execution stringState - The last execution state of the curation. Possible values: LAST_EXECUTION_STATE_UNSPECIFIED SUCCEEDED FAILED
- name string
- Identifier. The name of the curation.
Format:
projects/{project}/locations/{location}/curations/{curation}
- plugin
Instance CurationActions Plugin Instance Action[] - The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance. Structure is documented below.
- update
Time string - The time at which the curation was last updated.
- create_
time str - The time at which the curation was created.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
execution_ strerror_ code - The error code of the last execution of the curation. The error code is populated only when the last execution state is failed. Possible values: ERROR_CODE_UNSPECIFIED INTERNAL_ERROR UNAUTHORIZED
- last_
execution_ strerror_ message - Error message describing the failure, if any, during the last execution of the curation.
- last_
execution_ strstate - The last execution state of the curation. Possible values: LAST_EXECUTION_STATE_UNSPECIFIED SUCCEEDED FAILED
- name str
- Identifier. The name of the curation.
Format:
projects/{project}/locations/{location}/curations/{curation}
- plugin_
instance_ Sequence[Curationactions Plugin Instance Action] - The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance. Structure is documented below.
- update_
time str - The time at which the curation was last updated.
- create
Time String - The time at which the curation was created.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Execution StringError Code - The error code of the last execution of the curation. The error code is populated only when the last execution state is failed. Possible values: ERROR_CODE_UNSPECIFIED INTERNAL_ERROR UNAUTHORIZED
- last
Execution StringError Message - Error message describing the failure, if any, during the last execution of the curation.
- last
Execution StringState - The last execution state of the curation. Possible values: LAST_EXECUTION_STATE_UNSPECIFIED SUCCEEDED FAILED
- name String
- Identifier. The name of the curation.
Format:
projects/{project}/locations/{location}/curations/{curation}
- plugin
Instance List<Property Map>Actions - The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance. Structure is documented below.
- update
Time String - The time at which the curation was last updated.
Look up Existing Curation Resource
Get an existing Curation resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: CurationState, opts?: CustomResourceOptions): Curation
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
create_time: Optional[str] = None,
curation_id: Optional[str] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
endpoint: Optional[CurationEndpointArgs] = None,
last_execution_error_code: Optional[str] = None,
last_execution_error_message: Optional[str] = None,
last_execution_state: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
plugin_instance_actions: Optional[Sequence[CurationPluginInstanceActionArgs]] = None,
project: Optional[str] = None,
update_time: Optional[str] = None) -> Curation
func GetCuration(ctx *Context, name string, id IDInput, state *CurationState, opts ...ResourceOption) (*Curation, error)
public static Curation Get(string name, Input<string> id, CurationState? state, CustomResourceOptions? opts = null)
public static Curation get(String name, Output<String> id, CurationState state, CustomResourceOptions options)
resources: _: type: gcp:apihub:Curation get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Create
Time string - The time at which the curation was created.
- Curation
Id string - The ID to use for the curation resource, which will become the final
component of the curations's resource name. This field is optional.
- If provided, the same will be used. The service will throw an error if the specified ID is already used by another curation resource in the API hub.
- If not provided, a system generated ID will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
- Description string
- The description of the curation.
- Display
Name string - The display name of the curation.
- Endpoint
Curation
Endpoint - The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. Structure is documented below.
- Last
Execution stringError Code - The error code of the last execution of the curation. The error code is populated only when the last execution state is failed. Possible values: ERROR_CODE_UNSPECIFIED INTERNAL_ERROR UNAUTHORIZED
- Last
Execution stringError Message - Error message describing the failure, if any, during the last execution of the curation.
- Last
Execution stringState - The last execution state of the curation. Possible values: LAST_EXECUTION_STATE_UNSPECIFIED SUCCEEDED FAILED
- Location string
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Name string
- Identifier. The name of the curation.
Format:
projects/{project}/locations/{location}/curations/{curation}
- Plugin
Instance List<CurationActions Plugin Instance Action> - The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance. Structure is documented below.
- Project string
- Update
Time string - The time at which the curation was last updated.
- Create
Time string - The time at which the curation was created.
- Curation
Id string - The ID to use for the curation resource, which will become the final
component of the curations's resource name. This field is optional.
- If provided, the same will be used. The service will throw an error if the specified ID is already used by another curation resource in the API hub.
- If not provided, a system generated ID will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
- Description string
- The description of the curation.
- Display
Name string - The display name of the curation.
- Endpoint
Curation
Endpoint Args - The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. Structure is documented below.
- Last
Execution stringError Code - The error code of the last execution of the curation. The error code is populated only when the last execution state is failed. Possible values: ERROR_CODE_UNSPECIFIED INTERNAL_ERROR UNAUTHORIZED
- Last
Execution stringError Message - Error message describing the failure, if any, during the last execution of the curation.
- Last
Execution stringState - The last execution state of the curation. Possible values: LAST_EXECUTION_STATE_UNSPECIFIED SUCCEEDED FAILED
- Location string
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Name string
- Identifier. The name of the curation.
Format:
projects/{project}/locations/{location}/curations/{curation}
- Plugin
Instance []CurationActions Plugin Instance Action Args - The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance. Structure is documented below.
- Project string
- Update
Time string - The time at which the curation was last updated.
- create
Time String - The time at which the curation was created.
- curation
Id String - The ID to use for the curation resource, which will become the final
component of the curations's resource name. This field is optional.
- If provided, the same will be used. The service will throw an error if the specified ID is already used by another curation resource in the API hub.
- If not provided, a system generated ID will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
- description String
- The description of the curation.
- display
Name String - The display name of the curation.
- endpoint
Curation
Endpoint - The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. Structure is documented below.
- last
Execution StringError Code - The error code of the last execution of the curation. The error code is populated only when the last execution state is failed. Possible values: ERROR_CODE_UNSPECIFIED INTERNAL_ERROR UNAUTHORIZED
- last
Execution StringError Message - Error message describing the failure, if any, during the last execution of the curation.
- last
Execution StringState - The last execution state of the curation. Possible values: LAST_EXECUTION_STATE_UNSPECIFIED SUCCEEDED FAILED
- location String
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - name String
- Identifier. The name of the curation.
Format:
projects/{project}/locations/{location}/curations/{curation}
- plugin
Instance List<CurationActions Plugin Instance Action> - The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance. Structure is documented below.
- project String
- update
Time String - The time at which the curation was last updated.
- create
Time string - The time at which the curation was created.
- curation
Id string - The ID to use for the curation resource, which will become the final
component of the curations's resource name. This field is optional.
- If provided, the same will be used. The service will throw an error if the specified ID is already used by another curation resource in the API hub.
- If not provided, a system generated ID will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
- description string
- The description of the curation.
- display
Name string - The display name of the curation.
- endpoint
Curation
Endpoint - The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. Structure is documented below.
- last
Execution stringError Code - The error code of the last execution of the curation. The error code is populated only when the last execution state is failed. Possible values: ERROR_CODE_UNSPECIFIED INTERNAL_ERROR UNAUTHORIZED
- last
Execution stringError Message - Error message describing the failure, if any, during the last execution of the curation.
- last
Execution stringState - The last execution state of the curation. Possible values: LAST_EXECUTION_STATE_UNSPECIFIED SUCCEEDED FAILED
- location string
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - name string
- Identifier. The name of the curation.
Format:
projects/{project}/locations/{location}/curations/{curation}
- plugin
Instance CurationActions Plugin Instance Action[] - The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance. Structure is documented below.
- project string
- update
Time string - The time at which the curation was last updated.
- create_
time str - The time at which the curation was created.
- curation_
id str - The ID to use for the curation resource, which will become the final
component of the curations's resource name. This field is optional.
- If provided, the same will be used. The service will throw an error if the specified ID is already used by another curation resource in the API hub.
- If not provided, a system generated ID will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
- description str
- The description of the curation.
- display_
name str - The display name of the curation.
- endpoint
Curation
Endpoint Args - The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. Structure is documented below.
- last_
execution_ strerror_ code - The error code of the last execution of the curation. The error code is populated only when the last execution state is failed. Possible values: ERROR_CODE_UNSPECIFIED INTERNAL_ERROR UNAUTHORIZED
- last_
execution_ strerror_ message - Error message describing the failure, if any, during the last execution of the curation.
- last_
execution_ strstate - The last execution state of the curation. Possible values: LAST_EXECUTION_STATE_UNSPECIFIED SUCCEEDED FAILED
- location str
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - name str
- Identifier. The name of the curation.
Format:
projects/{project}/locations/{location}/curations/{curation}
- plugin_
instance_ Sequence[Curationactions Plugin Instance Action Args] - The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance. Structure is documented below.
- project str
- update_
time str - The time at which the curation was last updated.
- create
Time String - The time at which the curation was created.
- curation
Id String - The ID to use for the curation resource, which will become the final
component of the curations's resource name. This field is optional.
- If provided, the same will be used. The service will throw an error if the specified ID is already used by another curation resource in the API hub.
- If not provided, a system generated ID will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
- description String
- The description of the curation.
- display
Name String - The display name of the curation.
- endpoint Property Map
- The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. Structure is documented below.
- last
Execution StringError Code - The error code of the last execution of the curation. The error code is populated only when the last execution state is failed. Possible values: ERROR_CODE_UNSPECIFIED INTERNAL_ERROR UNAUTHORIZED
- last
Execution StringError Message - Error message describing the failure, if any, during the last execution of the curation.
- last
Execution StringState - The last execution state of the curation. Possible values: LAST_EXECUTION_STATE_UNSPECIFIED SUCCEEDED FAILED
- location String
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - name String
- Identifier. The name of the curation.
Format:
projects/{project}/locations/{location}/curations/{curation}
- plugin
Instance List<Property Map>Actions - The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance. Structure is documented below.
- project String
- update
Time String - The time at which the curation was last updated.
Supporting Types
CurationEndpoint, CurationEndpointArgs
- Application
Integration CurationEndpoint Details Endpoint Application Integration Endpoint Details - The details of the Application Integration endpoint to be triggered for curation. Structure is documented below.
- Application
Integration CurationEndpoint Details Endpoint Application Integration Endpoint Details - The details of the Application Integration endpoint to be triggered for curation. Structure is documented below.
- application
Integration CurationEndpoint Details Endpoint Application Integration Endpoint Details - The details of the Application Integration endpoint to be triggered for curation. Structure is documented below.
- application
Integration CurationEndpoint Details Endpoint Application Integration Endpoint Details - The details of the Application Integration endpoint to be triggered for curation. Structure is documented below.
- application_
integration_ Curationendpoint_ details Endpoint Application Integration Endpoint Details - The details of the Application Integration endpoint to be triggered for curation. Structure is documented below.
- application
Integration Property MapEndpoint Details - The details of the Application Integration endpoint to be triggered for curation. Structure is documented below.
CurationEndpointApplicationIntegrationEndpointDetails, CurationEndpointApplicationIntegrationEndpointDetailsArgs
- Trigger
Id string - The API trigger ID of the Application Integration workflow.
- Uri string
- The endpoint URI should be a valid REST URI for triggering an Application
Integration.
Format:
https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute
orhttps://{location}-integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute
- Trigger
Id string - The API trigger ID of the Application Integration workflow.
- Uri string
- The endpoint URI should be a valid REST URI for triggering an Application
Integration.
Format:
https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute
orhttps://{location}-integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute
- trigger
Id String - The API trigger ID of the Application Integration workflow.
- uri String
- The endpoint URI should be a valid REST URI for triggering an Application
Integration.
Format:
https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute
orhttps://{location}-integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute
- trigger
Id string - The API trigger ID of the Application Integration workflow.
- uri string
- The endpoint URI should be a valid REST URI for triggering an Application
Integration.
Format:
https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute
orhttps://{location}-integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute
- trigger_
id str - The API trigger ID of the Application Integration workflow.
- uri str
- The endpoint URI should be a valid REST URI for triggering an Application
Integration.
Format:
https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute
orhttps://{location}-integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute
- trigger
Id String - The API trigger ID of the Application Integration workflow.
- uri String
- The endpoint URI should be a valid REST URI for triggering an Application
Integration.
Format:
https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute
orhttps://{location}-integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute
CurationPluginInstanceAction, CurationPluginInstanceActionArgs
- Action
Id string - (Output) The action ID that is using the curation. This should map to one of the action IDs specified in action configs in the plugin.
- Plugin
Instance string - (Output)
Plugin instance that is using the curation.
Format is
projects/{project}/locations/{locati on}/plugins/{plugin}/instances/{instance}
- Action
Id string - (Output) The action ID that is using the curation. This should map to one of the action IDs specified in action configs in the plugin.
- Plugin
Instance string - (Output)
Plugin instance that is using the curation.
Format is
projects/{project}/locations/{locati on}/plugins/{plugin}/instances/{instance}
- action
Id String - (Output) The action ID that is using the curation. This should map to one of the action IDs specified in action configs in the plugin.
- plugin
Instance String - (Output)
Plugin instance that is using the curation.
Format is
projects/{project}/locations/{locati on}/plugins/{plugin}/instances/{instance}
- action
Id string - (Output) The action ID that is using the curation. This should map to one of the action IDs specified in action configs in the plugin.
- plugin
Instance string - (Output)
Plugin instance that is using the curation.
Format is
projects/{project}/locations/{locati on}/plugins/{plugin}/instances/{instance}
- action_
id str - (Output) The action ID that is using the curation. This should map to one of the action IDs specified in action configs in the plugin.
- plugin_
instance str - (Output)
Plugin instance that is using the curation.
Format is
projects/{project}/locations/{locati on}/plugins/{plugin}/instances/{instance}
- action
Id String - (Output) The action ID that is using the curation. This should map to one of the action IDs specified in action configs in the plugin.
- plugin
Instance String - (Output)
Plugin instance that is using the curation.
Format is
projects/{project}/locations/{locati on}/plugins/{plugin}/instances/{instance}
Import
Curation can be imported using any of these accepted formats:
projects/{{project}}/locations/{{location}}/curations/{{curation_id}}
{{project}}/{{location}}/{{curation_id}}
{{location}}/{{curation_id}}
When using the pulumi import
command, Curation can be imported using one of the formats above. For example:
$ pulumi import gcp:apihub/curation:Curation default projects/{{project}}/locations/{{location}}/curations/{{curation_id}}
$ pulumi import gcp:apihub/curation:Curation default {{project}}/{{location}}/{{curation_id}}
$ pulumi import gcp:apihub/curation:Curation default {{location}}/{{curation_id}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-beta
Terraform Provider.