Class Product (0.8.0)

public final class Product extends GeneratedMessageV3 implements ProductOrBuilder

The readonly representation of a product computed with a given resource context.

Protobuf type google.cloud.privatecatalog.v1beta1.Product

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Product

Implements

ProductOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ASSET_REFERENCES_FIELD_NUMBER

public static final int ASSET_REFERENCES_FIELD_NUMBER

Field Value

Type	Description
int

ASSET_TYPE_FIELD_NUMBER

public static final int ASSET_TYPE_FIELD_NUMBER

Field Value

Type	Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

Field Value

Type	Description
int

DISPLAY_METADATA_FIELD_NUMBER

public static final int DISPLAY_METADATA_FIELD_NUMBER

Field Value

Type	Description
int

ICON_URI_FIELD_NUMBER

public static final int ICON_URI_FIELD_NUMBER

Field Value

Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value

Type	Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static Product getDefaultInstance()

Returns

Type	Description
Product

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static Product.Builder newBuilder()

Returns

Type	Description
Product.Builder

newBuilder(Product prototype)

public static Product.Builder newBuilder(Product prototype)

Parameter

Name	Description
prototype	`Product`

Returns

Type	Description
Product.Builder

parseDelimitedFrom(InputStream input)

public static Product parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	`InputStream`

Returns

Type	Description
Product

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Product parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`InputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
Product

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static Product parseFrom(byte[] data)

Parameter

Name	Description
data	`byte[]`

Returns

Type	Description
Product

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Product parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	`byte[]`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
Product

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Product parseFrom(ByteString data)

Parameter

Name	Description
data	`ByteString`

Returns

Type	Description
Product

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Product parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	`ByteString`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
Product

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Product parseFrom(CodedInputStream input)

Parameter

Name	Description
input	`CodedInputStream`

Returns

Type	Description
Product

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Product parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
Product

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static Product parseFrom(InputStream input)

Parameter

Name	Description
input	`InputStream`

Returns

Type	Description
Product

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Product parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`InputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
Product

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static Product parseFrom(ByteBuffer data)

Parameter

Name	Description
data	`ByteBuffer`

Returns

Type	Description
Product

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Product parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	`ByteBuffer`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
Product

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Product> parser()

Returns

Type	Description
Parser<Product>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	`Object`

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAssetReferences(int index)

public 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];

Parameter

Name	Description
index	`int`

Returns

Type	Description
AssetReference

getAssetReferencesCount()

public 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];

Returns

Type	Description
int

getAssetReferencesList()

public 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];

Returns

Type	Description
List<AssetReference>

getAssetReferencesOrBuilder(int index)

public 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];

Parameter

Name	Description
index	`int`

Returns

Type	Description
AssetReferenceOrBuilder

getAssetReferencesOrBuilderList()

public 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];

Returns

Type	Description
List<? extends com.google.cloud.privatecatalog.v1beta1.AssetReferenceOrBuilder>

getAssetType()

public 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

Type	Description
String	The assetType.

getAssetTypeBytes()

public 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

Type	Description
ByteString	The bytes for assetType.

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the product was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the product was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
TimestampOrBuilder

getDefaultInstanceForType()

public Product getDefaultInstanceForType()

Returns

Type	Description
Product

getDisplayMetadata()

public Struct getDisplayMetadata()

Required. Output only. The display metadata to describe the product. The JSON schema of the metadata differs by 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

Type	Description
Struct	The displayMetadata.

getDisplayMetadataOrBuilder()

public StructOrBuilder getDisplayMetadataOrBuilder()


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:

name

description additionalProperties: true

.google.protobuf.Struct display_metadata = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
StructOrBuilder

getIconUri()

public String getIconUri()

Output only. The icon URI of the product.

string icon_uri = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
String	The iconUri.

getIconUriBytes()

public ByteString getIconUriBytes()

Output only. The icon URI of the product.

string icon_uri = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
ByteString	The bytes for iconUri.

getName()

public String getName()

Output only. The resource name of the target product, in the format of `products/a-z*[a-z0-9]'. A unique identifier for the product under a catalog.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the target product, in the format of `products/a-z*[a-z0-9]'. A unique identifier for the product under a catalog.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
ByteString	The bytes for name.

getParserForType()

public Parser<Product> getParserForType()

Returns

Type	Description
Parser<Product>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

getUpdateTime()

public 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

Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time when the product was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the product was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the createTime field is set.

hasDisplayMetadata()

public boolean hasDisplayMetadata()


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:

name

description additionalProperties: true

.google.protobuf.Struct display_metadata = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the displayMetadata field is set.

hasUpdateTime()

public 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

Type	Description
boolean	Whether the updateTime field is set.

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Product.Builder newBuilderForType()

Returns

Type	Description
Product.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Product.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	`BuilderParent`

Returns

Type	Description
Product.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	`UnusedPrivateParameter`

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Product.Builder toBuilder()

Returns

Type	Description
Product.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException