Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dialogflow
  5. dialogflow/v2
  6. Document

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.dialogflow/v2.Document

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Creates a new document. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: Document

    Create Document Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Document(name: string, args: DocumentArgs, opts?: CustomResourceOptions);
    @overload
def Document(resource_name: str,
             args: DocumentArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Document(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             display_name: Optional[str] = None,
             knowledge_base_id: Optional[str] = None,
             knowledge_types: Optional[Sequence[DocumentKnowledgeTypesItem]] = None,
             mime_type: Optional[str] = None,
             content_uri: Optional[str] = None,
             enable_auto_reload: Optional[bool] = None,
             location: Optional[str] = None,
             metadata: Optional[Mapping[str, str]] = None,
             name: Optional[str] = None,
             project: Optional[str] = None,
             raw_content: Optional[str] = None)
    func NewDocument(ctx *Context, name string, args DocumentArgs, opts ...ResourceOption) (*Document, error)
    public Document(string name, DocumentArgs args, CustomResourceOptions? opts = null)
    public Document(String name, DocumentArgs args)
public Document(String name, DocumentArgs args, CustomResourceOptions options)

    type: google-native:dialogflow/v2:Document
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 DocumentArgs
    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 DocumentArgs
    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 DocumentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DocumentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DocumentArgs
    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 google_nativeDocumentResource = new GoogleNative.Dialogflow.V2.Document("google-nativeDocumentResource", new()
{
    DisplayName = "string",
    KnowledgeBaseId = "string",
    KnowledgeTypes = new[]
    {
        GoogleNative.Dialogflow.V2.DocumentKnowledgeTypesItem.KnowledgeTypeUnspecified,
    },
    MimeType = "string",
    ContentUri = "string",
    EnableAutoReload = false,
    Location = "string",
    Metadata = 
    {
        { "string", "string" },
    },
    Name = "string",
    Project = "string",
    RawContent = "string",
});

    example, err := dialogflow.NewDocument(ctx, "google-nativeDocumentResource", &dialogflow.DocumentArgs{
DisplayName: pulumi.String("string"),
KnowledgeBaseId: pulumi.String("string"),
KnowledgeTypes: dialogflow.DocumentKnowledgeTypesItemArray{
dialogflow.DocumentKnowledgeTypesItemKnowledgeTypeUnspecified,
},
MimeType: pulumi.String("string"),
ContentUri: pulumi.String("string"),
EnableAutoReload: pulumi.Bool(false),
Location: pulumi.String("string"),
Metadata: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
Project: pulumi.String("string"),
RawContent: pulumi.String("string"),
})

    var google_nativeDocumentResource = new Document("google-nativeDocumentResource", DocumentArgs.builder()
    .displayName("string")
    .knowledgeBaseId("string")
    .knowledgeTypes("KNOWLEDGE_TYPE_UNSPECIFIED")
    .mimeType("string")
    .contentUri("string")
    .enableAutoReload(false)
    .location("string")
    .metadata(Map.of("string", "string"))
    .name("string")
    .project("string")
    .rawContent("string")
    .build());

    google_native_document_resource = google_native.dialogflow.v2.Document("google-nativeDocumentResource",
    display_name="string",
    knowledge_base_id="string",
    knowledge_types=[google_native.dialogflow.v2.DocumentKnowledgeTypesItem.KNOWLEDGE_TYPE_UNSPECIFIED],
    mime_type="string",
    content_uri="string",
    enable_auto_reload=False,
    location="string",
    metadata={
        "string": "string",
    },
    name="string",
    project="string",
    raw_content="string")

    const google_nativeDocumentResource = new google_native.dialogflow.v2.Document("google-nativeDocumentResource", {
    displayName: "string",
    knowledgeBaseId: "string",
    knowledgeTypes: [google_native.dialogflow.v2.DocumentKnowledgeTypesItem.KnowledgeTypeUnspecified],
    mimeType: "string",
    contentUri: "string",
    enableAutoReload: false,
    location: "string",
    metadata: {
        string: "string",
    },
    name: "string",
    project: "string",
    rawContent: "string",
});

    type: google-native:dialogflow/v2:Document
properties:
    contentUri: string
    displayName: string
    enableAutoReload: false
    knowledgeBaseId: string
    knowledgeTypes:
        - KNOWLEDGE_TYPE_UNSPECIFIED
    location: string
    metadata:
        string: string
    mimeType: string
    name: string
    project: string
    rawContent: string

    Document Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Document resource accepts the following input properties:

    DisplayName string
    The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.
    KnowledgeBaseId string
    KnowledgeTypes List<Pulumi.GoogleNative.Dialogflow.V2.DocumentKnowledgeTypesItem>
    The knowledge type of document content.
    MimeType string
    The MIME type of this document.
    ContentUri string
    The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form gs:///. NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the gs:// format URI described above.
    EnableAutoReload bool
    Optional. If true, we try to automatically reload the document every day (at a time picked by the system). If false or unspecified, we don't try to automatically reload the document. Currently you can only enable automatic reload for documents sourced from a public url, see source field for the source types. Reload status can be tracked in latest_reload_status. If a reload fails, we will keep the document unchanged. If a reload fails with internal errors, the system will try to reload the document on the next day. If a reload fails with non-retriable errors (e.g. PERMISSION_DENIED), the system will not try to reload the document anymore. You need to manually reload the document successfully by calling ReloadDocument and clear the errors.
    Location string
    Metadata Dictionary<string, string>
    Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a key or a value of the metadata is 1024 bytes.
    Name string
    Optional. The document resource name. The name must be empty when creating a document. Format: projects//locations//knowledgeBases//documents/.
    Project string
    RawContent string
    The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.
    DisplayName string
    The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.
    KnowledgeBaseId string
    KnowledgeTypes []DocumentKnowledgeTypesItem
    The knowledge type of document content.
    MimeType string
    The MIME type of this document.
    ContentUri string
    The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form gs:///. NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the gs:// format URI described above.
    EnableAutoReload bool
    Optional. If true, we try to automatically reload the document every day (at a time picked by the system). If false or unspecified, we don't try to automatically reload the document. Currently you can only enable automatic reload for documents sourced from a public url, see source field for the source types. Reload status can be tracked in latest_reload_status. If a reload fails, we will keep the document unchanged. If a reload fails with internal errors, the system will try to reload the document on the next day. If a reload fails with non-retriable errors (e.g. PERMISSION_DENIED), the system will not try to reload the document anymore. You need to manually reload the document successfully by calling ReloadDocument and clear the errors.
    Location string
    Metadata map[string]string
    Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a key or a value of the metadata is 1024 bytes.
    Name string
    Optional. The document resource name. The name must be empty when creating a document. Format: projects//locations//knowledgeBases//documents/.
    Project string
    RawContent string
    The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.
    displayName String
    The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.
    knowledgeBaseId String
    knowledgeTypes List<DocumentKnowledgeTypesItem>
    The knowledge type of document content.
    mimeType String
    The MIME type of this document.
    contentUri String
    The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form gs:///. NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the gs:// format URI described above.
    enableAutoReload Boolean
    Optional. If true, we try to automatically reload the document every day (at a time picked by the system). If false or unspecified, we don't try to automatically reload the document. Currently you can only enable automatic reload for documents sourced from a public url, see source field for the source types. Reload status can be tracked in latest_reload_status. If a reload fails, we will keep the document unchanged. If a reload fails with internal errors, the system will try to reload the document on the next day. If a reload fails with non-retriable errors (e.g. PERMISSION_DENIED), the system will not try to reload the document anymore. You need to manually reload the document successfully by calling ReloadDocument and clear the errors.
    location String
    metadata Map<String,String>
    Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a key or a value of the metadata is 1024 bytes.
    name String
    Optional. The document resource name. The name must be empty when creating a document. Format: projects//locations//knowledgeBases//documents/.
    project String
    rawContent String
    The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.
    displayName string
    The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.
    knowledgeBaseId string
    knowledgeTypes DocumentKnowledgeTypesItem[]
    The knowledge type of document content.
    mimeType string
    The MIME type of this document.
    contentUri string
    The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form gs:///. NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the gs:// format URI described above.
    enableAutoReload boolean
    Optional. If true, we try to automatically reload the document every day (at a time picked by the system). If false or unspecified, we don't try to automatically reload the document. Currently you can only enable automatic reload for documents sourced from a public url, see source field for the source types. Reload status can be tracked in latest_reload_status. If a reload fails, we will keep the document unchanged. If a reload fails with internal errors, the system will try to reload the document on the next day. If a reload fails with non-retriable errors (e.g. PERMISSION_DENIED), the system will not try to reload the document anymore. You need to manually reload the document successfully by calling ReloadDocument and clear the errors.
    location string
    metadata {[key: string]: string}
    Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a key or a value of the metadata is 1024 bytes.
    name string
    Optional. The document resource name. The name must be empty when creating a document. Format: projects//locations//knowledgeBases//documents/.
    project string
    rawContent string
    The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.
    display_name str
    The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.
    knowledge_base_id str
    knowledge_types Sequence[DocumentKnowledgeTypesItem]
    The knowledge type of document content.
    mime_type str
    The MIME type of this document.
    content_uri str
    The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form gs:///. NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the gs:// format URI described above.
    enable_auto_reload bool
    Optional. If true, we try to automatically reload the document every day (at a time picked by the system). If false or unspecified, we don't try to automatically reload the document. Currently you can only enable automatic reload for documents sourced from a public url, see source field for the source types. Reload status can be tracked in latest_reload_status. If a reload fails, we will keep the document unchanged. If a reload fails with internal errors, the system will try to reload the document on the next day. If a reload fails with non-retriable errors (e.g. PERMISSION_DENIED), the system will not try to reload the document anymore. You need to manually reload the document successfully by calling ReloadDocument and clear the errors.
    location str
    metadata Mapping[str, str]
    Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a key or a value of the metadata is 1024 bytes.
    name str
    Optional. The document resource name. The name must be empty when creating a document. Format: projects//locations//knowledgeBases//documents/.
    project str
    raw_content str
    The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.
    displayName String
    The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.
    knowledgeBaseId String
    knowledgeTypes List<"KNOWLEDGE_TYPE_UNSPECIFIED" | "FAQ" | "EXTRACTIVE_QA" | "ARTICLE_SUGGESTION" | "AGENT_FACING_SMART_REPLY">
    The knowledge type of document content.
    mimeType String
    The MIME type of this document.
    contentUri String
    The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form gs:///. NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the gs:// format URI described above.
    enableAutoReload Boolean
    Optional. If true, we try to automatically reload the document every day (at a time picked by the system). If false or unspecified, we don't try to automatically reload the document. Currently you can only enable automatic reload for documents sourced from a public url, see source field for the source types. Reload status can be tracked in latest_reload_status. If a reload fails, we will keep the document unchanged. If a reload fails with internal errors, the system will try to reload the document on the next day. If a reload fails with non-retriable errors (e.g. PERMISSION_DENIED), the system will not try to reload the document anymore. You need to manually reload the document successfully by calling ReloadDocument and clear the errors.
    location String
    metadata Map<String>
    Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a key or a value of the metadata is 1024 bytes.
    name String
    Optional. The document resource name. The name must be empty when creating a document. Format: projects//locations//knowledgeBases//documents/.
    project String
    rawContent String
    The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Document resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    LatestReloadStatus Pulumi.GoogleNative.Dialogflow.V2.Outputs.GoogleCloudDialogflowV2DocumentReloadStatusResponse
    The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.
    State string
    The current state of the document.
    Id string
    The provider-assigned unique ID for this managed resource.
    LatestReloadStatus GoogleCloudDialogflowV2DocumentReloadStatusResponse
    The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.
    State string
    The current state of the document.
    id String
    The provider-assigned unique ID for this managed resource.
    latestReloadStatus GoogleCloudDialogflowV2DocumentReloadStatusResponse
    The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.
    state String
    The current state of the document.
    id string
    The provider-assigned unique ID for this managed resource.
    latestReloadStatus GoogleCloudDialogflowV2DocumentReloadStatusResponse
    The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.
    state string
    The current state of the document.
    id str
    The provider-assigned unique ID for this managed resource.
    latest_reload_status GoogleCloudDialogflowV2DocumentReloadStatusResponse
    The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.
    state str
    The current state of the document.
    id String
    The provider-assigned unique ID for this managed resource.
    latestReloadStatus Property Map
    The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.
    state String
    The current state of the document.

    Supporting Types

    DocumentKnowledgeTypesItem, DocumentKnowledgeTypesItemArgs

    KnowledgeTypeUnspecified
    KNOWLEDGE_TYPE_UNSPECIFIEDThe type is unspecified or arbitrary.
    Faq
    FAQThe document content contains question and answer pairs as either HTML or CSV. Typical FAQ HTML formats are parsed accurately, but unusual formats may fail to be parsed. CSV must have questions in the first column and answers in the second, with no header. Because of this explicit format, they are always parsed accurately.
    ExtractiveQa
    EXTRACTIVE_QADocuments for which unstructured text is extracted and used for question answering.
    ArticleSuggestion
    ARTICLE_SUGGESTIONThe entire document content as a whole can be used for query results. Only for Contact Center Solutions on Dialogflow.
    AgentFacingSmartReply
    AGENT_FACING_SMART_REPLYThe document contains agent-facing Smart Reply entries.
    DocumentKnowledgeTypesItemKnowledgeTypeUnspecified
    KNOWLEDGE_TYPE_UNSPECIFIEDThe type is unspecified or arbitrary.
    DocumentKnowledgeTypesItemFaq
    FAQThe document content contains question and answer pairs as either HTML or CSV. Typical FAQ HTML formats are parsed accurately, but unusual formats may fail to be parsed. CSV must have questions in the first column and answers in the second, with no header. Because of this explicit format, they are always parsed accurately.
    DocumentKnowledgeTypesItemExtractiveQa
    EXTRACTIVE_QADocuments for which unstructured text is extracted and used for question answering.
    DocumentKnowledgeTypesItemArticleSuggestion
    ARTICLE_SUGGESTIONThe entire document content as a whole can be used for query results. Only for Contact Center Solutions on Dialogflow.
    DocumentKnowledgeTypesItemAgentFacingSmartReply
    AGENT_FACING_SMART_REPLYThe document contains agent-facing Smart Reply entries.
    KnowledgeTypeUnspecified
    KNOWLEDGE_TYPE_UNSPECIFIEDThe type is unspecified or arbitrary.
    Faq
    FAQThe document content contains question and answer pairs as either HTML or CSV. Typical FAQ HTML formats are parsed accurately, but unusual formats may fail to be parsed. CSV must have questions in the first column and answers in the second, with no header. Because of this explicit format, they are always parsed accurately.
    ExtractiveQa
    EXTRACTIVE_QADocuments for which unstructured text is extracted and used for question answering.
    ArticleSuggestion
    ARTICLE_SUGGESTIONThe entire document content as a whole can be used for query results. Only for Contact Center Solutions on Dialogflow.
    AgentFacingSmartReply
    AGENT_FACING_SMART_REPLYThe document contains agent-facing Smart Reply entries.
    KnowledgeTypeUnspecified
    KNOWLEDGE_TYPE_UNSPECIFIEDThe type is unspecified or arbitrary.
    Faq
    FAQThe document content contains question and answer pairs as either HTML or CSV. Typical FAQ HTML formats are parsed accurately, but unusual formats may fail to be parsed. CSV must have questions in the first column and answers in the second, with no header. Because of this explicit format, they are always parsed accurately.
    ExtractiveQa
    EXTRACTIVE_QADocuments for which unstructured text is extracted and used for question answering.
    ArticleSuggestion
    ARTICLE_SUGGESTIONThe entire document content as a whole can be used for query results. Only for Contact Center Solutions on Dialogflow.
    AgentFacingSmartReply
    AGENT_FACING_SMART_REPLYThe document contains agent-facing Smart Reply entries.
    KNOWLEDGE_TYPE_UNSPECIFIED
    KNOWLEDGE_TYPE_UNSPECIFIEDThe type is unspecified or arbitrary.
    FAQ
    FAQThe document content contains question and answer pairs as either HTML or CSV. Typical FAQ HTML formats are parsed accurately, but unusual formats may fail to be parsed. CSV must have questions in the first column and answers in the second, with no header. Because of this explicit format, they are always parsed accurately.
    EXTRACTIVE_QA
    EXTRACTIVE_QADocuments for which unstructured text is extracted and used for question answering.
    ARTICLE_SUGGESTION
    ARTICLE_SUGGESTIONThe entire document content as a whole can be used for query results. Only for Contact Center Solutions on Dialogflow.
    AGENT_FACING_SMART_REPLY
    AGENT_FACING_SMART_REPLYThe document contains agent-facing Smart Reply entries.
    "KNOWLEDGE_TYPE_UNSPECIFIED"
    KNOWLEDGE_TYPE_UNSPECIFIEDThe type is unspecified or arbitrary.
    "FAQ"
    FAQThe document content contains question and answer pairs as either HTML or CSV. Typical FAQ HTML formats are parsed accurately, but unusual formats may fail to be parsed. CSV must have questions in the first column and answers in the second, with no header. Because of this explicit format, they are always parsed accurately.
    "EXTRACTIVE_QA"
    EXTRACTIVE_QADocuments for which unstructured text is extracted and used for question answering.
    "ARTICLE_SUGGESTION"
    ARTICLE_SUGGESTIONThe entire document content as a whole can be used for query results. Only for Contact Center Solutions on Dialogflow.
    "AGENT_FACING_SMART_REPLY"
    AGENT_FACING_SMART_REPLYThe document contains agent-facing Smart Reply entries.

    GoogleCloudDialogflowV2DocumentReloadStatusResponse, GoogleCloudDialogflowV2DocumentReloadStatusResponseArgs

    Status Pulumi.GoogleNative.Dialogflow.V2.Inputs.GoogleRpcStatusResponse
    The status of a reload attempt or the initial load.
    Time string
    The time of a reload attempt. This reload may have been triggered automatically or manually and may not have succeeded.
    Status GoogleRpcStatusResponse
    The status of a reload attempt or the initial load.
    Time string
    The time of a reload attempt. This reload may have been triggered automatically or manually and may not have succeeded.
    status GoogleRpcStatusResponse
    The status of a reload attempt or the initial load.
    time String
    The time of a reload attempt. This reload may have been triggered automatically or manually and may not have succeeded.
    status GoogleRpcStatusResponse
    The status of a reload attempt or the initial load.
    time string
    The time of a reload attempt. This reload may have been triggered automatically or manually and may not have succeeded.
    status GoogleRpcStatusResponse
    The status of a reload attempt or the initial load.
    time str
    The time of a reload attempt. This reload may have been triggered automatically or manually and may not have succeeded.
    status Property Map
    The status of a reload attempt or the initial load.
    time String
    The time of a reload attempt. This reload may have been triggered automatically or manually and may not have succeeded.

    GoogleRpcStatusResponse, GoogleRpcStatusResponseArgs

    Code int
    The status code, which should be an enum value of google.rpc.Code.
    Details List<ImmutableDictionary<string, string>>
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    Message string
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    Code int
    The status code, which should be an enum value of google.rpc.Code.
    Details []map[string]string
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    Message string
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code Integer
    The status code, which should be an enum value of google.rpc.Code.
    details List<Map<String,String>>
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message String
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code number
    The status code, which should be an enum value of google.rpc.Code.
    details {[key: string]: string}[]
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message string
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code int
    The status code, which should be an enum value of google.rpc.Code.
    details Sequence[Mapping[str, str]]
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message str
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code Number
    The status code, which should be an enum value of google.rpc.Code.
    details List<Map<String>>
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message String
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native