Interface ProductOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Product, Product.Builder

    public interface ProductOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Detail

      • getName

        String getName()
         Output only. The resource name of the target product, in the format of
         `products/[a-z][-a-z0-9]*[a-z0-9]'.
        
         A unique identifier for the product under a catalog.
         
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The name.
      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Output only. The resource name of the target product, in the format of
         `products/[a-z][-a-z0-9]*[a-z0-9]'.
        
         A unique identifier for the product under a catalog.
         
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for name.
      • getAssetType

        String getAssetType()
         Output only. The type of the product asset. It can be one of the following values:
        
         * `google.deploymentmanager.Template`
         * `google.cloudprivatecatalog.ListingOnly`
         * `google.cloudprivatecatalog.Terraform`
         
        string asset_type = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The assetType.
      • getAssetTypeBytes

        com.google.protobuf.ByteString getAssetTypeBytes()
         Output only. The type of the product asset. It can be one of the following values:
        
         * `google.deploymentmanager.Template`
         * `google.cloudprivatecatalog.ListingOnly`
         * `google.cloudprivatecatalog.Terraform`
         
        string asset_type = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for assetType.
      • hasDisplayMetadata

        boolean hasDisplayMetadata()
         Required. Output only. The display metadata to describe the product. The JSON schema of the
         metadata differs by [Product.asset_type][google.cloud.privatecatalog.v1beta1.Product.asset_type].
         When the type is `google.deploymentmanager.Template`, the schema is as
         follows:
        
         ```
         "$schema": http://json-schema.org/draft-04/schema#
         type: object
         properties:
           name:
             type: string
             minLength: 1
             maxLength: 64
           description:
             type: string
             minLength: 1
             maxLength: 2048
           tagline:
             type: string
             minLength: 1
             maxLength: 100
           support_info:
             type: string
             minLength: 1
             maxLength: 2048
           creator:
             type: string
             minLength: 1
             maxLength: 100
           documentations:
             type: array
             items:
               type: object
               properties:
                 url:
                   type: string
                   pattern:
                   "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
                 title:
                   type: string
                   minLength: 1
                   maxLength: 64
                 description:
                   type: string
                   minLength: 1
                   maxLength: 2048
         required:
         - name
         - description
         additionalProperties: false
        
         ```
        
         When the asset type is `google.cloudprivatecatalog.ListingOnly`, the schema
         is as follows:
        
         ```
         "$schema": http://json-schema.org/draft-04/schema#
         type: object
         properties:
           name:
             type: string
             minLength: 1
             maxLength: 64
           description:
             type: string
             minLength: 1
             maxLength: 2048
           tagline:
             type: string
             minLength: 1
             maxLength: 100
           support_info:
             type: string
             minLength: 1
             maxLength: 2048
           creator:
             type: string
             minLength: 1
             maxLength: 100
           documentations:
             type: array
             items:
               type: object
               properties:
                 url:
                   type: string
                   pattern:
                   "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
                 title:
                   type: string
                   minLength: 1
                   maxLength: 64
                 description:
                   type: string
                   minLength: 1
                   maxLength: 2048
           signup_url:
             type: string
             pattern:
             "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
         required:
         - name
         - description
         - signup_url
         additionalProperties: false
        
         ```
        
         When the asset type is `google.cloudprivatecatalog.Terraform`, the schema
         is as follows:
        
         ```
         "$schema": http://json-schema.org/draft-04/schema#
         type: object
         properties:
           name:
             type: string
             minLength: 1
             maxLength: 64
           description:
             type: string
             minLength: 1
             maxLength: 2048
           tagline:
             type: string
             minLength: 1
             maxLength: 100
           support_info:
             type: string
             minLength: 1
             maxLength: 2048
           creator:
             type: string
             minLength: 1
             maxLength: 100
           documentations:
             type: array
             items:
               type: object
               properties:
                 url:
                   type: string
                   pattern:
                   "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
                 title:
                   type: string
                   minLength: 1
                   maxLength: 64
                 description:
                   type: string
                   minLength: 1
                   maxLength: 2048
         required:
         - name
         - description
         additionalProperties: true
         
        .google.protobuf.Struct display_metadata = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the displayMetadata field is set.
      • getDisplayMetadata

        com.google.protobuf.Struct getDisplayMetadata()
         Required. Output only. The display metadata to describe the product. The JSON schema of the
         metadata differs by [Product.asset_type][google.cloud.privatecatalog.v1beta1.Product.asset_type].
         When the type is `google.deploymentmanager.Template`, the schema is as
         follows:
        
         ```
         "$schema": http://json-schema.org/draft-04/schema#
         type: object
         properties:
           name:
             type: string
             minLength: 1
             maxLength: 64
           description:
             type: string
             minLength: 1
             maxLength: 2048
           tagline:
             type: string
             minLength: 1
             maxLength: 100
           support_info:
             type: string
             minLength: 1
             maxLength: 2048
           creator:
             type: string
             minLength: 1
             maxLength: 100
           documentations:
             type: array
             items:
               type: object
               properties:
                 url:
                   type: string
                   pattern:
                   "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
                 title:
                   type: string
                   minLength: 1
                   maxLength: 64
                 description:
                   type: string
                   minLength: 1
                   maxLength: 2048
         required:
         - name
         - description
         additionalProperties: false
        
         ```
        
         When the asset type is `google.cloudprivatecatalog.ListingOnly`, the schema
         is as follows:
        
         ```
         "$schema": http://json-schema.org/draft-04/schema#
         type: object
         properties:
           name:
             type: string
             minLength: 1
             maxLength: 64
           description:
             type: string
             minLength: 1
             maxLength: 2048
           tagline:
             type: string
             minLength: 1
             maxLength: 100
           support_info:
             type: string
             minLength: 1
             maxLength: 2048
           creator:
             type: string
             minLength: 1
             maxLength: 100
           documentations:
             type: array
             items:
               type: object
               properties:
                 url:
                   type: string
                   pattern:
                   "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
                 title:
                   type: string
                   minLength: 1
                   maxLength: 64
                 description:
                   type: string
                   minLength: 1
                   maxLength: 2048
           signup_url:
             type: string
             pattern:
             "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
         required:
         - name
         - description
         - signup_url
         additionalProperties: false
        
         ```
        
         When the asset type is `google.cloudprivatecatalog.Terraform`, the schema
         is as follows:
        
         ```
         "$schema": http://json-schema.org/draft-04/schema#
         type: object
         properties:
           name:
             type: string
             minLength: 1
             maxLength: 64
           description:
             type: string
             minLength: 1
             maxLength: 2048
           tagline:
             type: string
             minLength: 1
             maxLength: 100
           support_info:
             type: string
             minLength: 1
             maxLength: 2048
           creator:
             type: string
             minLength: 1
             maxLength: 100
           documentations:
             type: array
             items:
               type: object
               properties:
                 url:
                   type: string
                   pattern:
                   "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
                 title:
                   type: string
                   minLength: 1
                   maxLength: 64
                 description:
                   type: string
                   minLength: 1
                   maxLength: 2048
         required:
         - name
         - description
         additionalProperties: true
         
        .google.protobuf.Struct display_metadata = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The displayMetadata.
      • getDisplayMetadataOrBuilder

        com.google.protobuf.StructOrBuilder getDisplayMetadataOrBuilder()
         Required. Output only. The display metadata to describe the product. The JSON schema of the
         metadata differs by [Product.asset_type][google.cloud.privatecatalog.v1beta1.Product.asset_type].
         When the type is `google.deploymentmanager.Template`, the schema is as
         follows:
        
         ```
         "$schema": http://json-schema.org/draft-04/schema#
         type: object
         properties:
           name:
             type: string
             minLength: 1
             maxLength: 64
           description:
             type: string
             minLength: 1
             maxLength: 2048
           tagline:
             type: string
             minLength: 1
             maxLength: 100
           support_info:
             type: string
             minLength: 1
             maxLength: 2048
           creator:
             type: string
             minLength: 1
             maxLength: 100
           documentations:
             type: array
             items:
               type: object
               properties:
                 url:
                   type: string
                   pattern:
                   "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
                 title:
                   type: string
                   minLength: 1
                   maxLength: 64
                 description:
                   type: string
                   minLength: 1
                   maxLength: 2048
         required:
         - name
         - description
         additionalProperties: false
        
         ```
        
         When the asset type is `google.cloudprivatecatalog.ListingOnly`, the schema
         is as follows:
        
         ```
         "$schema": http://json-schema.org/draft-04/schema#
         type: object
         properties:
           name:
             type: string
             minLength: 1
             maxLength: 64
           description:
             type: string
             minLength: 1
             maxLength: 2048
           tagline:
             type: string
             minLength: 1
             maxLength: 100
           support_info:
             type: string
             minLength: 1
             maxLength: 2048
           creator:
             type: string
             minLength: 1
             maxLength: 100
           documentations:
             type: array
             items:
               type: object
               properties:
                 url:
                   type: string
                   pattern:
                   "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
                 title:
                   type: string
                   minLength: 1
                   maxLength: 64
                 description:
                   type: string
                   minLength: 1
                   maxLength: 2048
           signup_url:
             type: string
             pattern:
             "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
         required:
         - name
         - description
         - signup_url
         additionalProperties: false
        
         ```
        
         When the asset type is `google.cloudprivatecatalog.Terraform`, the schema
         is as follows:
        
         ```
         "$schema": http://json-schema.org/draft-04/schema#
         type: object
         properties:
           name:
             type: string
             minLength: 1
             maxLength: 64
           description:
             type: string
             minLength: 1
             maxLength: 2048
           tagline:
             type: string
             minLength: 1
             maxLength: 100
           support_info:
             type: string
             minLength: 1
             maxLength: 2048
           creator:
             type: string
             minLength: 1
             maxLength: 100
           documentations:
             type: array
             items:
               type: object
               properties:
                 url:
                   type: string
                   pattern:
                   "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
                 title:
                   type: string
                   minLength: 1
                   maxLength: 64
                 description:
                   type: string
                   minLength: 1
                   maxLength: 2048
         required:
         - name
         - description
         additionalProperties: true
         
        .google.protobuf.Struct display_metadata = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = OUTPUT_ONLY];
      • getIconUri

        String getIconUri()
         Output only. The icon URI of the product.
         
        string icon_uri = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The iconUri.
      • getIconUriBytes

        com.google.protobuf.ByteString getIconUriBytes()
         Output only. The icon URI of the product.
         
        string icon_uri = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for iconUri.
      • getAssetReferencesList

        List<AssetReference> getAssetReferencesList()
         Output only. A collection of assets referred by a product.
         This field is set for Terraform Products only.
         
        repeated .google.cloud.privatecatalog.v1beta1.AssetReference asset_references = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getAssetReferences

        AssetReference getAssetReferences​(int index)
         Output only. A collection of assets referred by a product.
         This field is set for Terraform Products only.
         
        repeated .google.cloud.privatecatalog.v1beta1.AssetReference asset_references = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getAssetReferencesCount

        int getAssetReferencesCount()
         Output only. A collection of assets referred by a product.
         This field is set for Terraform Products only.
         
        repeated .google.cloud.privatecatalog.v1beta1.AssetReference asset_references = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getAssetReferencesOrBuilderList

        List<? extends AssetReferenceOrBuilder> getAssetReferencesOrBuilderList()
         Output only. A collection of assets referred by a product.
         This field is set for Terraform Products only.
         
        repeated .google.cloud.privatecatalog.v1beta1.AssetReference asset_references = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getAssetReferencesOrBuilder

        AssetReferenceOrBuilder getAssetReferencesOrBuilder​(int index)
         Output only. A collection of assets referred by a product.
         This field is set for Terraform Products only.
         
        repeated .google.cloud.privatecatalog.v1beta1.AssetReference asset_references = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • hasCreateTime

        boolean hasCreateTime()
         Output only. The time when the product was created.
         
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the createTime field is set.
      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         Output only. The time when the product was created.
         
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The createTime.
      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time when the product was created.
         
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • hasUpdateTime

        boolean hasUpdateTime()
         Output only. The time when the product was last updated.
         
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the updateTime field is set.
      • getUpdateTime

        com.google.protobuf.Timestamp getUpdateTime()
         Output only. The time when the product was last updated.
         
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The updateTime.
      • getUpdateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The time when the product was last updated.
         
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];